List withdrawals
Project withdrawals, page by page.
GET/withdrawals
System information
- API key
- Required
- Rate limit
- ∞
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | No | How many items to return. Default 20, from 1 to 100. |
| offset | integer | No | How many items to skip. Default 0. |
Response fields
| Parameter | Type | Description |
|---|---|---|
| items | array | Withdrawals on the current page. |
| items[].uuid | string | Withdrawal UUID. |
| items[].coinCode | string | Cryptocurrency code. |
| items[].networkCode | string | Blockchain network code. |
| items[].amount | string | Requested withdrawal amount. |
| items[].recipientAmount | string | Amount the recipient receives. |
| items[].debitAmount | string | Amount debited from the balance. |
| items[].address | string | Recipient address. |
| items[].status | string | Withdrawal status, see “Statuses”. |
| items[].networkFee | string | Network fee. |
| items[].txid | string | null | Blockchain transaction hash. Appears after broadcasting. |
| items[].createdAt | string | Creation date (ISO 8601). |
| items[].updatedAt | string | Last update date (ISO 8601). |
| items[].broadcastedAt | string | null | Date the transaction was broadcast (ISO 8601). |
| items[].confirmedAt | string | null | Confirmation date (ISO 8601). |
| pagination | object | Pagination details. |
| pagination.limit | integer | Page size. |
| pagination.offset | integer | Offset from the start of the list. |
| pagination.total | integer | Total number of records. |
Possible errors
| HTTP | Code | Description |
|---|---|---|
| 403 | ACCOUNT_ACCESS_DENIED | Withdrawals are disabled for the key. |