Account APIs
The Account APIs allow access to Etana custody account balances and transactions.
Get a snapshot of account balances
Get current account balances across all securities in the account.
Request method
account/core/balance
Parameters
| Field | Type | Description |
|---|---|---|
| accountId | string | The account identifier to be queried for. |
Response
| Field | Type | Description |
|---|---|---|
| accountId | string | The account identifier of the account. |
| balances | map of string:number | Total balance per security. |
| reserved | map of string:number | Amounts reserved per security. |
| unsettled | map of string:number | Internally tracked settlement amounts for integration with correspondents. |
Account balance updates
Provides updates on the account balances for a given account.
Subscription spec
| Field | Type | Description |
|---|---|---|
| item | string | "account/core/balance" |
| accountId | string | The account identifier of the account of interest. |
Update
| Field | Type | Description |
|---|---|---|
| accountId | string | The account identifier of the account. |
| balances | map of string:number | Total balance per security. |
| reserved | map of string:number | Amounts reserved per security. |
| unsettled | map of string:number | Internally tracked settlement amounts for integration with correspondents. |
Get a snapshot of transactions for an account
Get transactions for the given account.
Request method
account/core/txs
Parameters
| Field | Type | Description |
|---|---|---|
| accountId | string | The account identifier of the account. |
| offset | number | Skip this many transactions in the result set. |
| count | number | Return this many transactions in the result set, starting at offset. |
Response
| Field | Type | Description |
|---|---|---|
| [] | list of transactions | Transactions. |
Transaction updates for an account
Provides updates on new transactions as they are booked to the account.
Subscription spec
| Field | Type | Description |
|---|---|---|
| item | string | "account/core/txs" |
| accountId | string | The account identifier of the account of interest. |
Update
| Field | Type | Description |
|---|---|---|
| tid | number | The transaction identifier uniquely identifying this transaction. |
| accountId | string | The account to which this transaction applies. |
| secId | string | The security identifier for the transaction. |
| ts | number | A timestamp representing the time that the transaction was received by the accounting system. Epoch milliseconds. |
| amount | number | The amount of the transaction. |
| desc | string | Description as specified in the booking request. |