Web3 Cloud API (1.0.0)
Download OpenAPI specification:Download
BatchRegisterAddresses
Batch register addresses to given wallet.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
| wallet_id required | string Unique ID of wallet. |
| addresses | Array of strings [ 1 .. 1000 ] items Algorand address. |
Responses
Request samples
- Payload
Content type
application/json
{- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "addresses": "LPBKDDUNKPXE7GAICEDXGTNCAJNC6IFJUSD4IK2H2IIB3OAFXLM3RLLIVQ"
}Response samples
- 200
- 500
Content type
application/json
{ }BatchRemoveAddresses
Batch remove addresses from given wallet.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
| wallet_id required | string Unique ID of wallet. |
| addresses | Array of strings [ 1 .. 1000 ] items Algorand address. |
| remove_all | boolean If true, remove all addresses for given wallet. |
Responses
Request samples
- Payload
Content type
application/json
{- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "addresses": "LPBKDDUNKPXE7GAICEDXGTNCAJNC6IFJUSD4IK2H2IIB3OAFXLM3RLLIVQ",
- "remove_all": true
}Response samples
- 200
- 500
Content type
application/json
{ }GetAddress
Get address.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
| address required | string^[A-Z2-7]{58}$ Algorand address. |
Responses
Request samples
- Payload
Content type
application/json
{- "address": "LPBKDDUNKPXE7GAICEDXGTNCAJNC6IFJUSD4IK2H2IIB3OAFXLM3RLLIVQ"
}Response samples
- 200
- 500
Content type
application/json
{- "address": {
- "address": "LPBKDDUNKPXE7GAICEDXGTNCAJNC6IFJUSD4IK2H2IIB3OAFXLM3RLLIVQ",
- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "create_time": "2019-08-24T14:15:22Z"
}
}ListAddresses
List addresses of given wallet.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
| wallet_id required | string Unique ID of wallet. |
| page_size | integer <int64> <= 100 Default: "10" Number of items per page. |
| page_token | string Token for next page. |
Responses
Request samples
- Payload
Content type
application/json
{- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "page_size": 10,
- "page_token": "CXART7WOIQT6AAAK"
}Response samples
- 200
- 500
Content type
application/json
{- "addresses": [
- {
- "address": "LPBKDDUNKPXE7GAICEDXGTNCAJNC6IFJUSD4IK2H2IIB3OAFXLM3RLLIVQ",
- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "create_time": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "next_page_token": "CXART7WOIQT6AAAK"
}
}RegisterAddress
Register address to given wallet.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
| wallet_id required | string Unique ID of wallet. |
| address required | string^[A-Z2-7]{58}$ Algorand address. |
Responses
Request samples
- Payload
Content type
application/json
{- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "address": "LPBKDDUNKPXE7GAICEDXGTNCAJNC6IFJUSD4IK2H2IIB3OAFXLM3RLLIVQ"
}Response samples
- 200
- 500
Content type
application/json
{ }RemoveAddress
Remove address from given wallet.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
| wallet_id required | string Unique ID of wallet. |
| address required | string^[A-Z2-7]{58}$ Algorand address. |
Responses
Request samples
- Payload
Content type
application/json
{- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "address": "LPBKDDUNKPXE7GAICEDXGTNCAJNC6IFJUSD4IK2H2IIB3OAFXLM3RLLIVQ"
}Response samples
- 200
- 500
Content type
application/json
{ }GetWallet
Get wallet. 404 error will be returned if the wallet is not found.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
Either the wallet_id or address must be present.
| wallet_id | string Unique ID of wallet. |
| address | string^[A-Z2-7]{58}$ Algorand address. |
Responses
Request samples
- Payload
Content type
application/json
{- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "address": "LPBKDDUNKPXE7GAICEDXGTNCAJNC6IFJUSD4IK2H2IIB3OAFXLM3RLLIVQ"
}Response samples
- 200
- 500
Content type
application/json
{- "wallet": {
- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "name": "Alice Wallet",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
}ListWallets
List wallets.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
| page_size | integer <int64> <= 100 Default: "10" Number of items per page. |
| page_token | string Token for next page. |
Responses
Request samples
- Payload
Content type
application/json
{- "page_size": 10,
- "page_token": "CXART7WOIQT6AAAK"
}Response samples
- 200
- 500
Content type
application/json
{- "wallets": [
- {
- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "name": "Alice Wallet",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "next_page_token": "CXART7WOIQT6AAAK"
}
}RegisterWallet
Register wallet.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
| name required | string [ 1 .. 50 ] characters Wallet name. |
| address | string^[A-Z2-7]{58}$ Algorand address. |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "Alice Wallet",
- "address": "LPBKDDUNKPXE7GAICEDXGTNCAJNC6IFJUSD4IK2H2IIB3OAFXLM3RLLIVQ"
}Response samples
- 200
- 500
Content type
application/json
{- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}ListAssets
List assets of given wallet or address.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
Either the wallet_id or address must be present.
| wallet_id | string Unique ID of wallet. |
| asset_type required | any Value: "ASSET_TYPE_ALGO" Type of asset. |
| address required | string^[A-Z2-7]{58}$ Algorand address. |
| is_aggregated | boolean If true, aggregate the balances of all addresses for each asset type. |
| page_size | integer <int64> <= 100 Default: "10" Number of items per page. |
| page_token | string Token for next page. |
| exclude_zero_balance | boolean Default: "false" If true, exclude asset whose balance is 0. |
Responses
Request samples
- Payload
Content type
application/json
{- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "asset_type": "ASSET_TYPE_ALGO",
- "address": "LPBKDDUNKPXE7GAICEDXGTNCAJNC6IFJUSD4IK2H2IIB3OAFXLM3RLLIVQ",
- "is_aggregated": true,
- "page_size": 10,
- "page_token": "CXART7WOIQT6AAAK",
- "exclude_zero_balance": "false"
}Response samples
- 200
- 500
Content type
application/json
{- "assets": [
- {
- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "address": "LPBKDDUNKPXE7GAICEDXGTNCAJNC6IFJUSD4IK2H2IIB3OAFXLM3RLLIVQ",
- "asset_type": "ASSET_TYPE_ALGO",
- "balance": "1.9582"
}
], - "pagination": {
- "next_page_token": "CXART7WOIQT6AAAK"
}
}RefreshAssetBalances
Refresh balances of assets of given wallet or address.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
Either the wallet_id or address must be present.
| wallet_id | string Unique ID of wallet. |
| address required | string^[A-Z2-7]{58}$ Algorand address. |
| asset_type required | any Value: "ASSET_TYPE_ALGO" Type of asset. |
Responses
Request samples
- Payload
Content type
application/json
{- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "address": "LPBKDDUNKPXE7GAICEDXGTNCAJNC6IFJUSD4IK2H2IIB3OAFXLM3RLLIVQ",
- "asset_type": "ASSET_TYPE_ALGO"
}Response samples
- 200
- 500
Content type
application/json
{ }ListWebhookHeaders
List webhook headers.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
If webhook_id is not provided, return webhook headers without webhook_id.
| webhook_id | string Unique ID of webhook. |
Responses
Request samples
- Payload
Content type
application/json
{- "webhook_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}Response samples
- 200
- 500
Content type
application/json
{- "webhook_headers": [
- {
- "webhook_header_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "webhook_id": "0211db8c-2a84-423c-b49b-31ae486d1675",
- "header_key": "x-custom-header-key",
- "header_value": "custom-header-value"
}
]
}ListWebhookHistories
List webhook histories.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
| webhook_id | string Unique ID of webhook. |
| start_time | integer <int64> UnixTime indicating from which point to retrieve the webhook history. |
| end_time | integer <int64> UnixTime indicating until which point to retrieve the webhook history. |
| page_size | integer <int64> <= 100 Default: "10" Number of items per page. |
| page_token | string Token for next page. |
Responses
Request samples
- Payload
Content type
application/json
{- "webhook_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "start_time": 1690373019,
- "end_time": 1690374019,
- "page_size": 10,
- "page_token": "string"
}Response samples
- 200
- 500
Content type
application/json
{- "webhook_histories": [
- {
- "webhook_history_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "webhook_id": "69fb80d8-998d-483b-b4db-068e7dac2374",
- "webhook_status": "WEBHOOK_STATUS_COMPLETED",
- "notification_type": "NOTIFICATION_TYPE_ALGORAND_TRANSACTION_UPDATED",
- "delivery_count": 1,
- "delivery_time": "2019-08-24T14:15:22Z",
- "data": { }
}
], - "pagination": {
- "next_page_token": "CXART7WOIQT6AAAK"
}
}RegisterWebhook
Register webhook to get notified on wallet activities.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
If wallet_id is not provided, webhook will be registered for all wallets.
| wallet_id | string Unique ID of wallet. |
| webhook_endpoint required | string Webhook endpoint. |
| confirmation required | integer <int64> The threshold of block confirmations before the Webhook is triggered. |
Responses
Request samples
- Payload
Content type
application/json
{- "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "confirmation": 10
}Response samples
- 200
- 500
Content type
application/json
{- "webhook_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}RegisterWebhookHeader
Register webhook header.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
If webhook_id is not provided, given webhook header will be applied to all webhooks.
| webhook_id | string Unique ID of webhook. |
| header_key required | string <= 1000 characters Webhook header key. |
| header_value required | string <= 1000 characters Webhook header value. |
Responses
Request samples
- Payload
Content type
application/json
{- "webhook_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
- "header_key": "x-custom-header-key",
- "header_value": "custom-header-value"
}Response samples
- 200
- 500
Content type
application/json
{- "webhook_header_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}RemoveWebhook
Remove webhook.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
| webhook_id required | string Unique ID of webhook. |
Responses
Request samples
- Payload
Content type
application/json
{- "webhook_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}Response samples
- 200
- 500
Content type
application/json
{ }RemoveWebhookHeader
Remove webhook header.
Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
| webhook_header_id required | string Unique ID of webhook header. |
Responses
Request samples
- Payload
Content type
application/json
{- "webhook_header_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}Response samples
- 200
- 500
Content type
application/json
{ }