Skip to main content

Avalanche

#

API docs by Redocly

Web3 Cloud API (1.0.0)

Download OpenAPI specification:Download

Address

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

EVM addresses.

Responses

Request samples

Content type
application/json
{
  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "addresses": [
    ]
}

Response samples

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

EVM addresses.

remove_all
boolean

If true, remove all addresses for given wallet.

Responses

Request samples

Content type
application/json
{
  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "addresses": [
    ],
  • "remove_all": true
}

Response samples

Content type
application/json
{ }

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^0x[a-f0-9]{40}$

EVM address.

Responses

Request samples

Content type
application/json
{
  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e"
}

Response samples

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^0x[a-f0-9]{40}$

EVM address.

Responses

Request samples

Content type
application/json
{
  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e"
}

Response samples

Content type
application/json
{ }

Transaction

CancelTransaction

Cancel transaction.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
transaction_id
required
string

Unique ID of transaction.

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}

Response samples

Content type
application/json
{ }

CreateTokenTransaction

Create transaction to transfer tokens.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
wallet_id
required
string

Unique ID of wallet.

contract_type
required
any
Enum: "CONTRACT_TYPE_ERC20" "CONTRACT_TYPE_ERC721"

Type of contract.

from
required
string^0x[a-f0-9]{40}$

Sender EVM address.

to
required
string^0x[a-f0-9]{40}$

Recipient EVM address.

gas
string

Decimal value of gas for transaction in wei. Default gas is set by eth_estimateGas.

max_fee_per_gas
string

Decimal value of maxFeePerGas for transaction in wei. Default max fee per gas is (2 * latestBlock.baseFeePerGas) + maxPriorityFeePerGas.

max_priority_fee_per_gas
string
Default: "0"

Decimal value of maxPriorityFeePerGas for transaction in wei.

object (v1TokenPayload)
nonce
integer <int64>

Transaction nonce. Default nonce is set by eth_getTransactionCount.

transaction_id
string

Unique ID of transaction to be created. If not provided, newly generated uuid is assigned.

Responses

Request samples

Content type
application/json
{
  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "contract_type": "CONTRACT_TYPE_ERC20",
  • "from": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "to": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
  • "gas": "1000000000",
  • "max_fee_per_gas": "1000000000",
  • "max_priority_fee_per_gas": "1000000000",
  • "token_payload": {
    },
  • "nonce": "10",
  • "transaction_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}

Response samples

Content type
application/json
{
  • "transaction": {
    }
}

CreateTransaction

Create transaction.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
wallet_id
required
string

Unique ID of wallet.

from
required
string^0x[a-f0-9]{40}$

Sender EVM address.

to
required
string^0x[a-f0-9]{40}$

Recipient EVM address.

value
required
string

Decimal value to send for transaction in wei.

gas
string

Decimal value of gas for transaction in wei. Default gas is set by eth_estimateGas.

max_fee_per_gas
string

Decimal value of maxFeePerGas for transaction in wei. Default max fee per gas is (2 * latestBlock.baseFeePerGas) + maxPriorityFeePerGas.

max_priority_fee_per_gas
string
Default: "0"

Decimal value of maxPriorityFeePerGas for transaction in wei.

data
string

Transaction data.

nonce
integer <int64>

Transaction nonce. Default nonce is set by eth_getTransactionCount.

transaction_id
string

Unique ID of transaction to be created. If not provided, newly generated uuid is assigned.

Responses

Request samples

Content type
application/json
{
  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "from": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "to": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
  • "value": "1000000000",
  • "gas": "1000000000",
  • "max_fee_per_gas": "1000000000",
  • "max_priority_fee_per_gas": "1000000000",
  • "data": "0xa9059cbb000000000000000000000000ce133b2cc42f16b4aadcbec492ddc2dfe1dc29900000000000000000000000000000000000000000000000006fae442a611eaad0",
  • "nonce": "10",
  • "transaction_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}

Response samples

Content type
application/json
{
  • "transaction": {
    }
}

GetEstimatedFee

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
object (v1GetEstimatedFeeRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "base_fee_per_gas": "string",
  • "priority_fee_per_gas": {
    }
}

GetTransaction

Get transaction.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json

Either the transaction_id or transaction_hash must be present.

transaction_id
string

Unique ID of transaction.

transaction_hash
string

Transaction hash.

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "transaction_hash": "0x1832e1bd87663e585cba09672468e07bba651f29d93c04df3e93e276448be0d6"
}

Response samples

Content type
application/json
{
  • "transaction": {
    }
}

GetTransactionMessageToSign

Get hashed transaction message to sign.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
transaction_id
required
string

Unique ID of transaction.

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}

Response samples

Content type
application/json
{
  • "transaction_message_to_sign": "string"
}

ListTransactions

List transactions.

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^0x[a-f0-9]{40}$

EVM address.

page_size
integer <int64> <= 100
Default: "10"

Number of items per page.

page_token
string

Token for next page.

Responses

Request samples

Content type
application/json
{
  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "page_size": "10",
  • "page_token": "CXART7WOIQT6AAAK"
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "pagination": {
    }
}

SendTransaction

Send transaction.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
transaction_id
required
string

Unique ID of transaction.

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}

Response samples

Content type
application/json
{
  • "transaction": {
    }
}

SubmitTransactionSignature

Submit transaction signature.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
transaction_id
required
string

Unique ID of transaction.

signature
required
string

Transaction signature.

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "signature": "0x93a46510a732f004451ac426efa4bac805d1edac6c8c4bf6d77aea48a8d5bc11149750fdbe00a0f189bfd694b33b9e15d052f174ff8664189b616a3dfce2225901"
}

Response samples

Content type
application/json
{ }

Contract

GetContract

Get registered contract.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
contract_address
required
string^0x[a-f0-9]{40}$

EVM contract address.

Responses

Request samples

Content type
application/json
{
  • "contract_address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e"
}

Response samples

Content type
application/json
{
  • "contract": {
    }
}

ListContracts

List registered contracts.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
object (v1ListContractsRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "contracts": [
    ]
}

RegisterContract

Register contract to record contract activity.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
contract_address
required
string^0x[a-f0-9]{40}$

EVM contract address.

contract_type
required
any
Enum: "CONTRACT_TYPE_ERC20" "CONTRACT_TYPE_ERC721" "CONTRACT_TYPE_ERC1155"

Type of contract.

Responses

Request samples

Content type
application/json
{
  • "contract_address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "contract_type": "CONTRACT_TYPE_ERC20"
}

Response samples

Content type
application/json
{ }

RemoveContract

Remove contract.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
contract_address
required
string^0x[a-f0-9]{40}$

EVM contract address.

Responses

Request samples

Content type
application/json
{
  • "contract_address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e"
}

Response samples

Content type
application/json
{ }

Wallet

GetWallet

Get wallet.

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^0x[a-f0-9]{40}$

EVM address.

Responses

Request samples

Content type
application/json
{
  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e"
}

Response samples

Content type
application/json
{
  • "wallet": {
    }
}

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

Content type
application/json
{
  • "page_size": 10,
  • "page_token": "CXART7WOIQT6AAAK"
}

Response samples

Content type
application/json
{
  • "wallets": [
    ],
  • "pagination": {
    }
}

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^0x[a-f0-9]{40}$

EVM address.

confirmation
integer <int64>
Default: "10"

Threshold of block confirmation number for wallet balance to be updated.

Responses

Request samples

Content type
application/json
{
  • "name": "Alice Wallet",
  • "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "confirmation": 1
}

Response samples

Content type
application/json
{
  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}

UpdateConfirmation

Update the threshold of block confirmation number for wallet balance to be updated.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
wallet_id
required
string

Unique ID of wallet.

confirmation
required
integer <int64>
Default: "10"

Block confirmation number.

Responses

Request samples

Content type
application/json
{
  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "confirmation": 1
}

Response samples

Content type
application/json
{ }

Asset

ImportAsset

Import asset of given address associated with the contract and token id.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
address
required
string^0x[a-f0-9]{40}$

EVM address.

asset_type
required
any
Enum: "ASSET_TYPE_AVAX" "ASSET_TYPE_ERC20" "ASSET_TYPE_ERC721" "ASSET_TYPE_ERC1155"

Type of asset.

contract_address
string^0x[a-f0-9]{40}$

EVM contract address.

token_id
string

token id.

Responses

Request samples

Content type
application/json
{
  • "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "asset_type": "ASSET_TYPE_ERC20",
  • "contract_address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "token_id": "11075"
}

Response samples

Content type
application/json
{ }

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
Enum: "ASSET_TYPE_AVAX" "ASSET_TYPE_ERC20" "ASSET_TYPE_ERC721" "ASSET_TYPE_ERC1155"

Type of asset.

address
string^0x[a-f0-9]{40}$

EVM address.

is_aggregated
boolean

If true, aggregate the balances of all addresses for each asset type.

contract_address
string^0x[a-f0-9]{40}$

EVM contract address.

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

Content type
application/json
{
  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "asset_type": "ASSET_TYPE_ERC20",
  • "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "is_aggregated": true,
  • "contract_address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "page_size": 10,
  • "page_token": "CXART7WOIQT6AAAK",
  • "exclude_zero_balance": "false"
}

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "pagination": {
    }
}

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
string^0x[a-f0-9]{40}$

EVM address.

asset_type
required
any
Enum: "ASSET_TYPE_AVAX" "ASSET_TYPE_ERC20" "ASSET_TYPE_ERC721" "ASSET_TYPE_ERC1155"

Type of asset.

Responses

Request samples

Content type
application/json
{
  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "asset_type": "ASSET_TYPE_ERC20"
}

Response samples

Content type
application/json
{ }

RefreshAssetMetadata

Refresh metadata of asset.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
contract_address
required
string^0x[a-f0-9]{40}$

EVM address.

token_id
required
string

ID of the token.

Responses

Request samples

Content type
application/json
{
  • "contract_address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "token_id": "68391930"
}

Response samples

Content type
application/json
{ }

Transfer

ListTransfers

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json

Either the wallet_id, address or transaction_hash must be present.

address
string^0x[a-f0-9]{40}$

EVM address.

start_time
integer <int64>

UnixTime indicating from which point to retrieve the transfer history.

end_time
integer <int64>

UnixTime indicating until which point to retrieve the transfer history.

page_size
integer <int64> <= 100
Default: "10"

Number of items per page.

page_token
string

Token for next page.

wallet_id
string

Unique ID of wallet.

transaction_hash
string

Transaction hash.

Responses

Request samples

Content type
application/json
{
  • "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "start_time": 1690373019,
  • "end_time": 1690374019,
  • "page_size": 10,
  • "page_token": "CXART7WOIQT6AAAK",
  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "transaction_hash": "0x1832e1bd87663e585cba09672468e07bba651f29d93c04df3e93e276448be0d6"
}

Response samples

Content type
application/json
{
  • "transfers": [
    ],
  • "pagination": {
    }
}

Webhook

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

Content type
application/json
{
  • "webhook_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}

Response samples

Content type
application/json
{
  • "webhook_headers": [
    ]
}

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

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

Content type
application/json
{
  • "webhook_histories": [
    ],
  • "pagination": {
    }
}

ListWebhooks

List webhooks.

Authorizations:
(x-api-keyx-api-noncex-api-signature)
Request Body schema: application/json
object (v1ListWebhooksRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "webhooks": [
    ]
}

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

Content type
application/json
{
  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "webhook_endpoint": "https://test/webhook",
  • "confirmation": 10
}

Response samples

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

Content type
application/json
{
  • "webhook_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "header_key": "x-custom-header-key",
  • "header_value": "custom-header-value"
}

Response samples

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

Content type
application/json
{
  • "webhook_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}

Response samples

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

Content type
application/json
{
  • "webhook_header_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"
}

Response samples

Content type
application/json
{ }