Fetch Financial Instrument Circulating Supply

Developing

Development

https://vf-solana-api.dev.alphaledger.com

POST

/api/v1/financial-instruments/single/circulating-supply

Fetches the circulating supply for the financial instrument.

the onchain value: current value of the circulating supply on the SVM network

the offchain value: the total of all token balance for all positions in the system for this financial instrument

Circulating supply as of a particular point in the past can only be fetch from offchain data, so the onchain value will not be provided if the asOf field is provided in the request.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://vf-solana-api.dev.alphaledger.com/api/v1/financial-instruments/single/circulating-supply?svmCluster=SOLANA_DEVNET' \
--header 'x-request-id: f9860f73-a466-41f2-a083-34eeb1cc3a3c' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "itemData": {
        "financialInstrument": {
            "onchainId": "GPjDgRPhSuJSya5GbaCWkYCDqcyL6N3ZBge9XMJsDton",
            "offchainId": "1b03ae9a-348c-4c18-8727-20c7c4ae7a0a",
            "offchainReferences": {
                "alId": "ALFNDPF000153778",
                "organizationExternalId": "ALT",
                "accountNumber": "ALT10000233",
                "code": "some-authority",
                "type": "WALLET"
            },
            "autoSign": true,
            "otherTenantOrganizationExternalId": "ALIM",
            "offPlatform": false
        },
        "asOf": "2024-09-26T07:58:30.996Z",
        "circulatingSupplyType": "ONCHAIN"
    },
    "tenancyConfig": {
        "overrideOrganizationExternalId": "ALIM"
    }
}'

Response Example

200 - Example 1

{
    "onchainCirculatingSupply": {
        "amount": 0,
        "lamports": 54993005
    },
    "offchainCirculatingSupply": {
        "amount": 0,
        "lamports": 54993005
    },
    "outOfBalance": true
}

Modified at 2026-02-28 08:42:14

Fetch Financial Instrument Details

Fetch Financial Instruments