Get account balances

Requisição

Segurança

httpAuth

Caminho

domainIdstring, (uuid)obrigatório

Unique identifier for the domain.

accountIdstring, (uuid)obrigatório

Consulta

limitinteger, (int32), [ 1 .. 100 ]

The number of entities to return.

startingAfterstring, (uuid)

Ticker id used to the determine beginning of query results.

sortBystring

Property name used to sort the query results.

Enum:"id""tickerId""totalAmount""reservedAmount""quarantinedAmount""lastUpdatedAt"

sortOrderstring

Sort order applied to the query results.

Enum:"ASC""DESC"

ticker.idArray of strings, (uuid)

Return balances of tickers with this id for the account.

Exemplo:ticker.id=4e066dff-e2aa-45ec-9398-1140e9aa98d9&ticker.id=f0390b50-1abd-47df-9580-b69a1298226a

ticker.nameArray of strings

Return balances of tickers with this name for the account.

Exemplo:ticker.name=mati&ticker.name=nft

ticker.symbolArray of strings

Return balances of tickers with this symbol for the account.

Exemplo:ticker.symbol=btc&ticker.symbol=doge

ticker.ledgerIdArray of strings

Return balances matching given ledger ids.

Exemplo:ticker.ledgerId=bitcoin&ticker.ledgerId=bitcoin-testnet

ticker.validationStatusstring

Return transfers with ticker matching the requested validation status

Enum:"Validated""NonValidated"

Exemplo:ticker.validationStatus=Validated

ticker.lockArray of strings

Return transfers with ticker matching given lock status.

Items Enum:"Unlocked""Locked""Archived"

Exemplo:ticker.lock=Locked&ticker.lock=Archived

curl -i -X GET \
  'https://docs.ripple.com/_mock/pt-br/products/custody/v1.34/devbox/v1/domains/{domainId}/accounts/{accountId}/balances?limit=1&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortBy=id&sortOrder=ASC&ticker.id=4e066dff-e2aa-45ec-9398-1140e9aa98d9%2Cf0390b50-1abd-47df-9580-b69a1298226a&ticker.name=mati%2Cnft&ticker.symbol=btc%2Cdoge&ticker.ledgerId=bitcoin%2Cbitcoin-testnet&ticker.validationStatus=Validated&ticker.lock=Locked%2CArchived' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

Corpoapplication/json

itemsArray of objectsobrigatório

countinteger, (int32)obrigatório

currentStartingAfterstring

nextStartingAfterstring

Resposta

{
  "items": [
    { … }
  ],
  "count": 0,
  "currentStartingAfter": "string",
  "nextStartingAfter": "string"
}