Fetch Accounts
Testing
Development
https://vf-solana-api.dev.alphaledger.com
Development
https://vf-solana-api.dev.alphaledger.com
POST
/api/v1/accounts/bulk/{detail-level}
Creates Solana Transaction:No
OperationId:fetchAccounts
Filter & Sort Options
| fieldName | dataType | description | filter | sort |
|---|---|---|---|---|
| managed | BOOLEAN | Managed vs un-manged accounts | (DESC)** | |
| type | OFFCHAIN_REFRENCE_TYPE | The offchain reference type | ||
| code | TEXT | The offchain reference code | ||
| alId | TEXT | The offchain reference AL ID | ||
| accountNumber | TEXT | The offchain reference account number | ||
| externalOrganizationId | TEXT | The offchain reference external organization id | ||
| offchainReferenceName | TEXT | The offchain reference name | ||
| status | TEXT | Indicates if the account is ACTIVE or CLOSED | ||
| lamportsBalance | NUMBER | Current offchain lamports balance | ||
| orgsIsGlobalFeePayerFor* | TEXT | Organization external ids for which the account is a global fee payer for | ||
| orgsAllowedToSignWithPrivateKey* | TEXT | Organization external ids for which their API Keys can use the private key of the account to sign transactions with it | ||
| lastTransactionAt | TIMESTAMP | Offchain timestamp of last transaction processed against this account | ||
| creationTransactionAt | TIMESTAMP | Offchain timestamp of creation transaction for this account | ||
| wasAlreadyOnchain | BOOLEAN | Indicates if the account was already on chain at the time of the account was onboarded into Vulcan Forge | ||
| privateKeyLocation | TEXT | Location of private key | ||
| canPayFees | BOOLEAN | Indicates if the account can pay Solana transaction and rent fees | ||
| sharedAccrossTenants | BOOLEAN | Indicates if the account is shared across tenants | ||
| comments | TEXT | The account's comments | ||
| solDebitApiKeys * | TEXT | The API Key that has restricted access to debit operations on SOL balance changes | ||
| tokenDebitApiKeys * | TEXT | The API Key that has restricted access to debit operations on token balance changes | ||
| tenantOrganizationId | TEXT | The external organization id associated with the blockchain account. This represents the tenant organization to which the API Key that created the account belongs to. |
* - indicates columns that are nullable and can use the IS_NULL or IS_NOT_NULL type
Request
Path Params
Query Params
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://vf-solana-api.dev.alphaledger.com/api/v1/accounts/bulk/compact?solanaClusterId=SOLANA_DEVNET' \
--header 'x-request-id: f9860f73-a466-41f2-a083-34eeb1cc3a3c' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"itemQuery": {
"limit": 10,
"skip": 0,
"filter": [
{
"fieldName": "See the endpoint description for allowed values",
"operator": "AND",
"filterValues": [
{
"dataType": "TEXT",
"filterType": "EQUALS",
"valueString": "string",
"valueNumber": 0,
"valueBoolean": true,
"valuesString": [
"string"
],
"valueFromString": "string",
"valueToString": "string",
"valueFromNumber": 0,
"valueToNumber": 0
}
]
}
],
"sort": [
{
"fieldName": "See the endpoint description for allowed values",
"sortDirection": "ASC"
}
]
},
"tenancyConfig": {
"overrideOrganizationExternalId": "ALIM"
}
}'Response Response Example
200 - Example 1
{
"count": 17,
"items": [
{
"onchain": {
"id": "6YaAdbMCV5GPRZ6AYbyEnGgggAHfEJjXTXYGrDVasQHK",
"lastTransactionId": "5vnjT6E19V4uQwHMojaR73XFoPjt9Y2nFn74xdDJZTK1MYScNWHpf876JFnSVzSqLxzEMLyzH355WWoiFN5ceMa9",
"lastTransactionAt": "2024-11-19T14:30:00.000Z",
"creationTransactionId": "3mTmwiMhwK286USNGGxCormm3srWcR5qmbCUb96jbz79Td53r6Nk2krCPeJ4LUUunwER8icNfGFXD2SQ8RnFPiZL",
"creationTransactionAt": "2024-11-19T14:30:00.000Z"
},
"offchain": {
"id": "b3e30f57-b404-4bd5-9e31-cec3298fa0bf",
"type": "WALLET",
"code": "BCDA",
"alId": "ALFNDPF000153786",
"organizationExternalId": "ALT",
"accountNumber": "ALT355566",
"name": "Trading Account",
"lamportsBalance": 4540000,
"tokenBalance": 2500000000,
"tokenDecimals": 8,
"lastTransactionId": "63e1c252-a23c-42af-a7f2-f48a2893c940",
"creationTransactionId": "f785791f-826b-4fe0-9547-6475518cdc7f"
},
"managed": true,
"status": "ACTIVE",
"privateKeyLocation": [
"SECRETS"
],
"isDerived": true,
"comments": "Some comments attached to the account",
"subscribeToNetworkEvents": true,
"sharedAcrossTenants": true,
"wasOnchainAlready": true,
"canPayFees": true,
"globalFeePayerForOrgs": [
"string"
],
"solDebitApiKeys": [
"string"
],
"tokenDebitApiKeys": [
"string"
],
"domain": "string",
"tenantOrganizationId": "ALG"
}
]
}Modified at 2026-01-16 09:45:43