Fetch Accounts

Fetches a list of accounts based on the provided query. Please note that the output fields will be trimmed to a smaller set of fields if the detail-level path parameter is set to identifiers or compact. Available detail levels:

Filter & Sort Options

Usage example can be found here.

Supported filter and data types can be found here. Allowed values in the fieldName for sortModel and filterModel:

fieldName	dataType	description	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 network currency 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.

(ASC|DESC)^** - columns that are part of the default sort if no itemQuery.sortModel is provided.
^* - indicates columns that are nullable and can use the IS_NULL or IS_NOT_NULL type

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Query Params

Header Params

Body Params application/json

Examples

curl --location --request POST 'https://vf-solana-api.dev.alphaledger.com/api/v1/accounts/bulk/compact?svmCluster=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" } }'

{ "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", "balance": { "amount": 0, "lamports": 54993005 }, "tokenDecimals": 0, "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" } ] }

Filter & Sort Options#

Request

Responses

Filter & Sort Options