Honeycluster Docs – List currencies an account can send or receive

Account Methods

List currencies an account can send or receive

wss://honeycluster.io

rpc method: account_currencies

Returns a list of currencies that an account can send or receive, based on its trust lines.

Try it now

Response · account_currencies WS Response

{
  "result": {
    "ledger_index": 89012345,
    "receive_currencies": [
      "USD",
      "EUR",
      "BTC"
    ],
    "send_currencies": [
      "USD",
      "EUR"
    ]
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request Message

account_currencies WS Request

application/json

List currencies an account can send or receive

Field	Type	Description
`command` required	string	WebSocket command name
`id`	object	Client-supplied identifier to correlate requests with responses.
`account`	string	The account to check for sendable/receivable currencies.
`ledger_index`	object	A ledger index (sequence number) or shortcut string identifying which ledger to use.
`ledger_hash`	string	256-bit hex hash identifying a specific ledger version.
`strict`	boolean	If true, only accept an account address in the proper base58 format.
`api_version`	object	API version for the response format. Version 2 is the default for rippled 2.0+.

Example

Json

{
  "command": "account_currencies",
  "id": 1,
  "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
  "ledger_index": "validated"
}

Response Message

account_currencies WS Response

application/json

WebSocket response for account_currencies

Field	Type	Description
`result`	object
`status`	enum<string>	Available `successerror`
`type`	string
`id`	stringnumber	Echo of the client-provided correlation ID

Example

Json

{
  "result": {
    "ledger_index": 89012345,
    "receive_currencies": [
      "USD",
      "EUR",
      "BTC"
    ],
    "send_currencies": [
      "USD",
      "EUR"
    ]
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request

Payload · JSON

const ws = new WebSocket('wss://honeycluster.io');

ws.addEventListener('open', () => {
  const request = {
    "command": "account_currencies",
    "id": 1,
    "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
    "ledger_index": "validated"
  };
  ws.send(JSON.stringify(request));
});

ws.addEventListener('message', (event: MessageEvent<string>) => {
  const response: unknown = JSON.parse(event.data);
  console.log(response);
  ws.close();
});

Response · account_currencies WS Response

{
  "result": {
    "ledger_index": 89012345,
    "receive_currencies": [
      "USD",
      "EUR",
      "BTC"
    ],
    "send_currencies": [
      "USD",
      "EUR"
    ]
  },
  "status": "success",
  "type": "response",
  "id": 1
}