openapi: 3.0.3
info:
title: 'Chaingateway API Documentation'
description: "\nChaingateway is a REST API for interactiong with Multiple Blockchain Networks like Ethereum, Binance Smart Chain, Tron, and more.\n\n## Authentication\nYou will need to add your Bearer Token to your `Authorization` header to authenticate your requests.\n\nFind more information about it here.\n\n## Networks\nThe API supports multiple networks, including Mainnets and testnets.\n\nTo switch to testnet api, simply add `X-Network` header to your request with value `testnet`.\n\nIf you want to use mainnet api, you can either remove the `X-Network` header or set it to `mainnet`.\n\nYou can find more information about the networks\nhere.\n\n## Additional resources\nDeveloper Portal\n\nQuick Start\n\nFAQ\n\nTutorials\n\n"
version: 2.1.0
servers:
-
url: 'https://app.chaingateway.io'
tags:
-
name: ''
description: 'Description for '
-
name: 'Tron Blockchain Queries'
description: 'Description for Tron Blockchain Queries'
-
name: 'Tron Transactions'
description: 'Description for Tron Transactions'
-
name: 'Tron Addresses'
description: 'Description for Tron Addresses'
-
name: 'Tron Staking'
description: 'Description for Tron Staking'
-
name: 'Tron Paymaster'
description: 'Description for Tron Paymaster'
-
name: 'Tron Webhooks'
description: 'Description for Tron Webhooks'
-
name: 'Ethereum Blockchain Queries'
description: 'Description for Ethereum Blockchain Queries'
-
name: 'Ethereum Transactions'
description: 'Description for Ethereum Transactions'
-
name: 'Ethereum Addresses'
description: 'Description for Ethereum Addresses'
-
name: 'Ethereum Webhooks'
description: 'Description for Ethereum Webhooks'
-
name: 'BSC Blockchain Queries'
description: 'Description for BSC Blockchain Queries'
-
name: 'BSC Transactions'
description: 'Description for BSC Transactions'
-
name: 'BSC Addresses'
description: 'Description for BSC Addresses'
-
name: 'BSC Webhooks'
description: 'Description for BSC Webhooks'
-
name: 'Solana Addresses'
description: 'Description for Solana Addresses'
-
name: 'Solana Blockchain Queries'
description: 'Description for Solana Blockchain Queries'
-
name: 'Solana Transactions'
description: 'Description for Solana Transactions'
-
name: 'Polygon Blockchain Queries'
description: 'Description for Polygon Blockchain Queries'
-
name: 'Polygon Transactions'
description: 'Description for Polygon Transactions'
-
name: 'Polygon Addresses'
description: 'Description for Polygon Addresses'
-
name: 'Polygon Webhooks'
description: 'Description for Polygon Webhooks'
-
name: 'Bitcoin Blockchain Queries'
description: 'Description for Bitcoin Blockchain Queries'
-
name: 'Bitcoin Transactions'
description: 'Description for Bitcoin Transactions'
-
name: 'Bitcoin Wallets'
description: 'Description for Bitcoin Wallets'
-
name: 'Bitcoin Webhooks'
description: 'Description for Bitcoin Webhooks'
-
name: 'Arbitrum Blockchain Queries'
description: 'Description for Arbitrum Blockchain Queries'
-
name: 'Arbitrum Transactions'
description: 'Description for Arbitrum Transactions'
-
name: 'Arbitrum Addresses'
description: 'Description for Arbitrum Addresses'
-
name: 'Arbitrum Webhooks'
description: 'Description for Arbitrum Webhooks'
-
name: 'Cryptocurrency Prices'
description: 'Description for Cryptocurrency Prices'
components:
securitySchemes:
default:
type: http
scheme: bearer
description: 'You can retrieve your token by visiting your dashboard and clicking API tokens in your user menu.'
security:
-
default: []
paths:
/api/account:
get:
summary: 'Get account info'
operationId: getAccountInfo
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Account info fetched'
data:
plan: PLUS
is_subscribed: 'true'
is_yearly: 0
ends_at: 25-05-03
quota_reset: null
status: active
payment_method: crypto
crypto_payment:
currency: USDT_TRC20
address: trx-84ab3d15d6de4a87b5f8686b28094f0d
eur_amount: '49.00'
crypto_amount: '60.04'
qr_code: 'https://sandbox.api.forumpay.com/pay/qr/?d=https%3A%2F%2Fsandbox.dashboard.forumpay.com%2Fpay%2FsandboxWallet.transfer%3Fcurrency%3DUSDT_TRC20%26address%3Dtrx-84ab3d15d6de4a87b5f8686b28094f0d'
quotas_left:
webhooks: 100000
addresses: 100000
requests: 999980
transactions: 99995
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Account info fetched'
data:
type: object
properties:
plan:
type: string
example: PLUS
is_subscribed:
type: string
example: 'true'
is_yearly:
type: integer
example: 0
ends_at:
type: string
example: 25-05-03
quota_reset:
type: string
example: null
status:
type: string
example: active
payment_method:
type: string
example: crypto
crypto_payment:
type: object
properties:
currency:
type: string
example: USDT_TRC20
address:
type: string
example: trx-84ab3d15d6de4a87b5f8686b28094f0d
eur_amount:
type: string
example: '49.00'
crypto_amount:
type: string
example: '60.04'
qr_code:
type: string
example: 'https://sandbox.api.forumpay.com/pay/qr/?d=https%3A%2F%2Fsandbox.dashboard.forumpay.com%2Fpay%2FsandboxWallet.transfer%3Fcurrency%3DUSDT_TRC20%26address%3Dtrx-84ab3d15d6de4a87b5f8686b28094f0d'
quotas_left:
type: object
properties:
webhooks:
type: integer
example: 100000
addresses:
type: integer
example: 100000
requests:
type: integer
example: 999980
transactions:
type: integer
example: 99995
tags:
- ''
/api/v2/tron/blocks/number:
get:
summary: 'Get the latest block number'
operationId: getTheLatestBlockNumber
description: 'This method returns the latest block number of the Tron blockchain'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'latest block number'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Latest block number fetched'
data:
blocknumber: 44776190
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Latest block number fetched'
data:
type: object
properties:
blocknumber:
type: integer
example: 44776190
tags:
- 'Tron Blockchain Queries'
'/api/v2/tron/blocks/{block_number}':
get:
summary: 'Get block by number or hash'
operationId: getBlockByNumberOrHash
description: 'This method returns the block by its number'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Block fetched'
data:
blockID: 0000000002ab3a92bdd1ad8459d8d01e364b2d3e2d0edde631eecae17cd54f4e
block_header:
raw_data:
number: 44776082
txTrieRoot: 0c41bd85e72082e7e91854527fd5edfcd5ec2f452ec391ff8773638646c3a003
witness_address: 414bbb38ac8f2c666f56c16e0b21ccda04d18b6b6b
parentHash: 0000000002ab3a917a556bfc48c0110cbe32928150a57c3d3f0f5a76ac41d6ec
version: 28
timestamp: 1709216589000
witness_signature: c28e39d518a41cbb44791d9ed3707f18d2e940d46a3ad894fbf6a78e87e429c56cee1cd8f4f18f45cc9c4435c5a0149b4fcf11298837e97013072bae39a0023100
transactions:
-
ret:
-
contractRet: SUCCESS
signature:
- b59efa8d33316f25bbbab3633dfefef10af3c5f1ba0d798eb8a49c1da60b95414c0b69e1dd59564364bbedcd0475d61e5af6e8ee1dafbb49a41692ad42f30aaf01
txID: a1760f27ef993fb6ab73777fd88121bab7eff73e8b2099bdeeda6f027352cab3
raw_data:
contract:
-
parameter:
value:
data: 0e99f793d577c125a59d385e58c5b2810ff69db870f2c28e9932e933b133339adc28bb310000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000134fb300000000000000000000000000000000000000000000000000000000000382da000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000065e093460000000000000000000000000000000000000000000000000000000000000000
owner_address: 414223e592ed4e72289e8e1fc16774caef785c092a
contract_address: 4187f9f4433e00eb0a1644e80d7159b1e54da21d31
type_url: type.googleapis.com/protocol.TriggerSmartContract
type: TriggerSmartContract
ref_block_bytes: 3a7f
ref_block_hash: 2a6ebc1bb5aee980
expiration: 1709216646000
fee_limit: 450000000
timestamp: 1709216587955
raw_data_hex: 0a023a7f22082a6ebc1bb5aee98040f08681aadf315ab003081f12ab030a31747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e54726967676572536d617274436f6e747261637412f5020a15414223e592ed4e72289e8e1fc16774caef785c092a12154187f9f4433e00eb0a1644e80d7159b1e54da21d3122c4020e99f793d577c125a59d385e58c5b2810ff69db870f2c28e9932e933b133339adc28bb310000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000134fb300000000000000000000000000000000000000000000000000000000000382da000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000065e09346000000000000000000000000000000000000000000000000000000000000000070b3c1fda9df31900180e9c9d601
-
ret:
-
contractRet: SUCCESS
signature:
- 439f51b1001c740f13c3344211dc0d1e2d5e00ffef57e246568b1e10ddcf503762675c2dd322a6f3ab2f15a798cf82689acf6d712e27b0ef8a46b98862a6b44a00
txID: 2c1f0fa4d57e949363da2913a4ab8aa7db9e61ba4e38cf9f53d48c1e5e566c23
raw_data:
contract:
-
parameter:
value:
data: 0e99f793176d0e33517ba3c8634c5a7c22dc16773c1518dd49a84f90493a1c44edf8021e0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000134fb300000000000000000000000000000000000000000000000000000000000382da000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000065e093450000000000000000000000000000000000000000000000000000000000000000
owner_address: 41d132364a6570470e4226c47079a0fa558eb4c78c
contract_address: 4126a733f2df06bb49dd6b7723cd033245108a4b47
type_url: type.googleapis.com/protocol.TriggerSmartContract
type: TriggerSmartContract
ref_block_bytes: 3a7f
ref_block_hash: 2a6ebc1bb5aee980
expiration: 1709216646000
fee_limit: 450000000
timestamp: 1709216588127
raw_data_hex: 0a023a7f22082a6ebc1bb5aee98040f08681aadf315ab003081f12ab030a31747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e54726967676572536d617274436f6e747261637412f5020a1541d132364a6570470e4226c47079a0fa558eb4c78c12154126a733f2df06bb49dd6b7723cd033245108a4b4722c4020e99f793176d0e33517ba3c8634c5a7c22dc16773c1518dd49a84f90493a1c44edf8021e0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000134fb300000000000000000000000000000000000000000000000000000000000382da000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000065e09345000000000000000000000000000000000000000000000000000000000000000070dfc2fda9df31900180e9c9d601
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Block fetched'
data:
type: object
properties:
blockID:
type: string
example: 0000000002ab3a92bdd1ad8459d8d01e364b2d3e2d0edde631eecae17cd54f4e
block_header:
type: object
properties:
raw_data:
type: object
properties:
number:
type: integer
example: 44776082
txTrieRoot:
type: string
example: 0c41bd85e72082e7e91854527fd5edfcd5ec2f452ec391ff8773638646c3a003
witness_address:
type: string
example: 414bbb38ac8f2c666f56c16e0b21ccda04d18b6b6b
parentHash:
type: string
example: 0000000002ab3a917a556bfc48c0110cbe32928150a57c3d3f0f5a76ac41d6ec
version:
type: integer
example: 28
timestamp:
type: integer
example: 1709216589000
witness_signature:
type: string
example: c28e39d518a41cbb44791d9ed3707f18d2e940d46a3ad894fbf6a78e87e429c56cee1cd8f4f18f45cc9c4435c5a0149b4fcf11298837e97013072bae39a0023100
transactions:
type: array
example:
-
ret:
-
contractRet: SUCCESS
signature:
- b59efa8d33316f25bbbab3633dfefef10af3c5f1ba0d798eb8a49c1da60b95414c0b69e1dd59564364bbedcd0475d61e5af6e8ee1dafbb49a41692ad42f30aaf01
txID: a1760f27ef993fb6ab73777fd88121bab7eff73e8b2099bdeeda6f027352cab3
raw_data:
contract:
-
parameter:
value:
data: 0e99f793d577c125a59d385e58c5b2810ff69db870f2c28e9932e933b133339adc28bb310000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000134fb300000000000000000000000000000000000000000000000000000000000382da000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000065e093460000000000000000000000000000000000000000000000000000000000000000
owner_address: 414223e592ed4e72289e8e1fc16774caef785c092a
contract_address: 4187f9f4433e00eb0a1644e80d7159b1e54da21d31
type_url: type.googleapis.com/protocol.TriggerSmartContract
type: TriggerSmartContract
ref_block_bytes: 3a7f
ref_block_hash: 2a6ebc1bb5aee980
expiration: 1709216646000
fee_limit: 450000000
timestamp: 1709216587955
raw_data_hex: 0a023a7f22082a6ebc1bb5aee98040f08681aadf315ab003081f12ab030a31747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e54726967676572536d617274436f6e747261637412f5020a15414223e592ed4e72289e8e1fc16774caef785c092a12154187f9f4433e00eb0a1644e80d7159b1e54da21d3122c4020e99f793d577c125a59d385e58c5b2810ff69db870f2c28e9932e933b133339adc28bb310000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000134fb300000000000000000000000000000000000000000000000000000000000382da000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000065e09346000000000000000000000000000000000000000000000000000000000000000070b3c1fda9df31900180e9c9d601
-
ret:
-
contractRet: SUCCESS
signature:
- 439f51b1001c740f13c3344211dc0d1e2d5e00ffef57e246568b1e10ddcf503762675c2dd322a6f3ab2f15a798cf82689acf6d712e27b0ef8a46b98862a6b44a00
txID: 2c1f0fa4d57e949363da2913a4ab8aa7db9e61ba4e38cf9f53d48c1e5e566c23
raw_data:
contract:
-
parameter:
value:
data: 0e99f793176d0e33517ba3c8634c5a7c22dc16773c1518dd49a84f90493a1c44edf8021e0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000134fb300000000000000000000000000000000000000000000000000000000000382da000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000065e093450000000000000000000000000000000000000000000000000000000000000000
owner_address: 41d132364a6570470e4226c47079a0fa558eb4c78c
contract_address: 4126a733f2df06bb49dd6b7723cd033245108a4b47
type_url: type.googleapis.com/protocol.TriggerSmartContract
type: TriggerSmartContract
ref_block_bytes: 3a7f
ref_block_hash: 2a6ebc1bb5aee980
expiration: 1709216646000
fee_limit: 450000000
timestamp: 1709216588127
raw_data_hex: 0a023a7f22082a6ebc1bb5aee98040f08681aadf315ab003081f12ab030a31747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e54726967676572536d617274436f6e747261637412f5020a1541d132364a6570470e4226c47079a0fa558eb4c78c12154126a733f2df06bb49dd6b7723cd033245108a4b4722c4020e99f793176d0e33517ba3c8634c5a7c22dc16773c1518dd49a84f90493a1c44edf8021e0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000134fb300000000000000000000000000000000000000000000000000000000000382da000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000065e09345000000000000000000000000000000000000000000000000000000000000000070dfc2fda9df31900180e9c9d601
items:
type: object
properties:
ret:
type: array
example:
-
contractRet: SUCCESS
items:
type: object
properties:
contractRet:
type: string
example: SUCCESS
signature:
type: array
example:
- b59efa8d33316f25bbbab3633dfefef10af3c5f1ba0d798eb8a49c1da60b95414c0b69e1dd59564364bbedcd0475d61e5af6e8ee1dafbb49a41692ad42f30aaf01
items:
type: string
txID:
type: string
example: a1760f27ef993fb6ab73777fd88121bab7eff73e8b2099bdeeda6f027352cab3
raw_data:
type: object
properties:
contract:
type: array
example:
-
parameter: { value: { data: 0e99f793d577c125a59d385e58c5b2810ff69db870f2c28e9932e933b133339adc28bb310000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000134fb300000000000000000000000000000000000000000000000000000000000382da000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000065e093460000000000000000000000000000000000000000000000000000000000000000, owner_address: 414223e592ed4e72289e8e1fc16774caef785c092a, contract_address: 4187f9f4433e00eb0a1644e80d7159b1e54da21d31 }, type_url: type.googleapis.com/protocol.TriggerSmartContract }
type: TriggerSmartContract
items:
type: object
properties:
parameter: { type: object, properties: { value: { type: object, properties: { data: { type: string, example: 0e99f793d577c125a59d385e58c5b2810ff69db870f2c28e9932e933b133339adc28bb310000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000134fb300000000000000000000000000000000000000000000000000000000000382da000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000065e093460000000000000000000000000000000000000000000000000000000000000000 }, owner_address: { type: string, example: 414223e592ed4e72289e8e1fc16774caef785c092a }, contract_address: { type: string, example: 4187f9f4433e00eb0a1644e80d7159b1e54da21d31 } } }, type_url: { type: string, example: type.googleapis.com/protocol.TriggerSmartContract } } }
type: { type: string, example: TriggerSmartContract }
ref_block_bytes:
type: string
example: 3a7f
ref_block_hash:
type: string
example: 2a6ebc1bb5aee980
expiration:
type: integer
example: 1709216646000
fee_limit:
type: integer
example: 450000000
timestamp:
type: integer
example: 1709216587955
raw_data_hex:
type: string
example: 0a023a7f22082a6ebc1bb5aee98040f08681aadf315ab003081f12ab030a31747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e54726967676572536d617274436f6e747261637412f5020a15414223e592ed4e72289e8e1fc16774caef785c092a12154187f9f4433e00eb0a1644e80d7159b1e54da21d3122c4020e99f793d577c125a59d385e58c5b2810ff69db870f2c28e9932e933b133339adc28bb310000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000134fb300000000000000000000000000000000000000000000000000000000000382da000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000065e09346000000000000000000000000000000000000000000000000000000000000000070b3c1fda9df31900180e9c9d601
tags:
- 'Tron Blockchain Queries'
parameters:
-
in: path
name: block_number
description: 'The block number'
example: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
required: true
schema:
type: string
/api/v2/tron/transactions:
get:
summary: 'List all Transactions'
operationId: listAllTransactions
description: "This method lists your transaction history. It lists all transactions including TRC20 and TRC721 transactions.
\n Please note that we dont index your addresses. We list only transactions that were made with the Chaingateway API"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Paginated results'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transactions'
current_page: 1
data:
-
id: 1
user_id: 1
blockchain: tron
network: testnet
type: TRX
txid: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.001000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T09:00:18.000000Z'
updated_at: '2024-02-13T09:00:18.000000Z'
-
id: 4
user_id: 1
blockchain: tron
network: testnet
type: TRX
txid: '0x5da4f33531fab8ecfe6f36a1300265f772b5f11c2da736a39b0b4b0c1b97c3e2'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.384200000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:01:26.000000Z'
updated_at: '2024-02-13T10:01:26.000000Z'
-
id: 5
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x1b7ecf53527e9a9ec09c448b2f594357e8a09f52c02c96d0de33fe435750d371'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:34:34.000000Z'
updated_at: '2024-02-13T10:34:34.000000Z'
-
id: 6
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x5b293a7289e8405fb8402f0bfa6e7464fdc9bfbc11aaa7874d4a7216b4079729'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:35:57.000000Z'
updated_at: '2024-02-13T10:35:57.000000Z'
-
id: 7
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x8830bd8d0cf0dfeac6d4cc345888ae52f9ca8b3a3cf37859919786bd9cd8ae2f'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '100.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:22:03.000000Z'
updated_at: '2024-02-13T12:22:03.000000Z'
-
id: 8
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:36:48.000000Z'
updated_at: '2024-02-13T12:36:48.000000Z'
first_page_url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
from: 1
last_page: 1
last_page_url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions'
per_page: 50
prev_page_url: null
to: 6
total: 6
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transactions'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 1
user_id: 1
blockchain: tron
network: testnet
type: TRX
txid: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.001000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T09:00:18.000000Z'
updated_at: '2024-02-13T09:00:18.000000Z'
-
id: 4
user_id: 1
blockchain: tron
network: testnet
type: TRX
txid: '0x5da4f33531fab8ecfe6f36a1300265f772b5f11c2da736a39b0b4b0c1b97c3e2'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.384200000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:01:26.000000Z'
updated_at: '2024-02-13T10:01:26.000000Z'
-
id: 5
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x1b7ecf53527e9a9ec09c448b2f594357e8a09f52c02c96d0de33fe435750d371'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:34:34.000000Z'
updated_at: '2024-02-13T10:34:34.000000Z'
-
id: 6
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x5b293a7289e8405fb8402f0bfa6e7464fdc9bfbc11aaa7874d4a7216b4079729'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:35:57.000000Z'
updated_at: '2024-02-13T10:35:57.000000Z'
-
id: 7
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x8830bd8d0cf0dfeac6d4cc345888ae52f9ca8b3a3cf37859919786bd9cd8ae2f'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '100.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:22:03.000000Z'
updated_at: '2024-02-13T12:22:03.000000Z'
-
id: 8
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:36:48.000000Z'
updated_at: '2024-02-13T12:36:48.000000Z'
items:
type: object
properties:
id:
type: integer
example: 1
user_id:
type: integer
example: 1
blockchain:
type: string
example: tron
network:
type: string
example: testnet
type:
type: string
example: TRX
txid:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from:
type: string
example: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to:
type: string
example: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress:
type: string
example: null
amount:
type: string
example: '0.001000000000'
tokenid:
type: string
example: null
responseJson:
type: string
example: null
httpStatus:
type: string
example: null
created_at:
type: string
example: '2024-02-13T09:00:18.000000Z'
updated_at:
type: string
example: '2024-02-13T09:00:18.000000Z'
first_page_url:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions'
per_page:
type: integer
example: 50
prev_page_url:
type: string
example: null
to:
type: integer
example: 6
total:
type: integer
example: 6
tags:
- 'Tron Transactions'
post:
summary: 'Send TRX'
operationId: sendTRX
description: "This method creates a new transaction.
\nIf the transaction is successful, it will return the transaction hash.
\nIf the transaction fails, it will return an error message.
"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created transaction'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created transaction'
data:
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created transaction'
data:
type: object
properties:
txid:
type: string
example: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Insufficent funds'
type: object
example:
status: 422
ok: false
message: 'class org.tron.core.exception.ContractValidateException : Validate TransferContract error, balance is not sufficient.'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'class org.tron.core.exception.ContractValidateException : Validate TransferContract error, balance is not sufficient.'
errors:
type: array
example: []
-
description: 'Wrong privatekey'
type: object
example:
status: 422
ok: false
message: 'Validate signature error: 0984bea42fc16d38512ef3f3ae0ad36b7123d1804a8b284106005793d441b2dd2d1bfdad10ec2879e06a35bbb9a89f268b81b79bc35f6031784c32fe60eee65e01 is signed by TT61CoyUW1ZwkcpkZAcortLvpYk7TW4fgD but it is not contained of permission.'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Validate signature error: 0984bea42fc16d38512ef3f3ae0ad36b7123d1804a8b284106005793d441b2dd2d1bfdad10ec2879e06a35bbb9a89f268b81b79bc35f6031784c32fe60eee65e01 is signed by TT61CoyUW1ZwkcpkZAcortLvpYk7TW4fgD but it is not contained of permission.'
errors:
type: array
example: []
tags:
- 'Tron Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
amount:
type: number
description: 'The amount to send.'
example: 1.0
password:
type: string
description: 'This field is required when privatekey is not present.'
example: '|]|{+-'
privatekey:
type: string
description: 'The private key of the sender.'
example: 708c419d1b9ae123047f70787a503b6ba51e048a27966e0220cc5feXXXXXXXXX
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^T[a-zA-Z0-9]{33}$/.'
example: TUwmZghA7u2GxGxKaxM1mkCmsTF4wHs4vp
from:
type: string
description: 'The address to send the transaction from. Must match the regex /^T[a-zA-Z0-9]{33}$/.'
example: TLkkCeNdJKPNUwucdro84WjswkzM62LCTH
required:
- amount
- to
- from
parameters:
-
in: path
name: page
description: 'Optional parameter. The page number'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '1'
'/api/v2/tron/transactions/{txid}':
get:
summary: 'Show Transaction'
operationId: showTransaction
description: "This method shows a transaction
\nIf the transaction is successful, it will return the transaction details.
\nIf the transaction fails, it will return an error message.
"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: Transaction
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction receipt'
data:
transaction:
ret:
-
contractRet: SUCCESS
signature:
- b75218466a3c1a141f8a2e776ec02b8aed247175193cdfa15d6bcdecac686e782edf4623c758f3483876316189d1dcc7c2aae154210038a7562b57ee49fbe99400
txID: 1b66c3d50dc32690a352f3cec78cd247d02a57a5c521865fb2a137785f129a7d
raw_data:
contract:
-
parameter:
value:
amount: 1000000
owner_address: 41764e0536d24197cd869232bf7b09f58820cde9d2
to_address: 41d024bd62f3da57306ad1f9b469acdb66dc292912
type_url: type.googleapis.com/protocol.TransferContract
type: TransferContract
ref_block_bytes: '1159'
ref_block_hash: 2c0d8fbacaf7ced9
expiration: 1708979589000
timestamp: 1708979530210
raw_data_hex: 0a02115922082c0d8fbacaf7ced940889ffcb8de315a67080112630a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412320a1541764e0536d24197cd869232bf7b09f58820cde9d2121541d024bd62f3da57306ad1f9b469acdb66dc29291218c0843d70e2d3f8b8de31
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction receipt'
data:
type: object
properties:
transaction:
type: object
properties:
ret:
type: array
example:
-
contractRet: SUCCESS
items:
type: object
properties:
contractRet:
type: string
example: SUCCESS
signature:
type: array
example:
- b75218466a3c1a141f8a2e776ec02b8aed247175193cdfa15d6bcdecac686e782edf4623c758f3483876316189d1dcc7c2aae154210038a7562b57ee49fbe99400
items:
type: string
txID:
type: string
example: 1b66c3d50dc32690a352f3cec78cd247d02a57a5c521865fb2a137785f129a7d
raw_data:
type: object
properties:
contract:
type: array
example:
-
parameter:
value: { amount: 1000000, owner_address: 41764e0536d24197cd869232bf7b09f58820cde9d2, to_address: 41d024bd62f3da57306ad1f9b469acdb66dc292912 }
type_url: type.googleapis.com/protocol.TransferContract
type: TransferContract
items:
type: object
properties:
parameter:
type: object
properties: { value: { type: object, properties: { amount: { type: integer, example: 1000000 }, owner_address: { type: string, example: 41764e0536d24197cd869232bf7b09f58820cde9d2 }, to_address: { type: string, example: 41d024bd62f3da57306ad1f9b469acdb66dc292912 } } }, type_url: { type: string, example: type.googleapis.com/protocol.TransferContract } }
type:
type: string
example: TransferContract
ref_block_bytes:
type: string
example: '1159'
ref_block_hash:
type: string
example: 2c0d8fbacaf7ced9
expiration:
type: integer
example: 1708979589000
timestamp:
type: integer
example: 1708979530210
raw_data_hex:
type: string
example: 0a02115922082c0d8fbacaf7ced940889ffcb8de315a67080112630a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412320a1541764e0536d24197cd869232bf7b09f58820cde9d2121541d024bd62f3da57306ad1f9b469acdb66dc29291218c0843d70e2d3f8b8de31
tags:
- 'Tron Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
'/api/v2/tron/transactions/{txid}/decoded':
get:
summary: 'Show Decoded Transaction'
operationId: showDecodedTransaction
description: "This method shows a transaction with decoded values
\nIf the transaction is successful, it will return the transaction details.
\nIf the transaction fails, it will return an error message.
"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: Transaction
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction receipt'
data:
transaction:
txid: 1b66c3d50dc32690a352f3cec78cd247d02a57a5c521865fb2a137785f129a7d
from: TLkkCeNdJKPNUwucdro84WjswkzM62LCTH
to: TUwmZghA7u2GxGxKaxM1mkCmsTF4wHs4vp
amount: '1.000000'
blocknumber: 44700012
confirmations: 55416
type: Tron
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction receipt'
data:
type: object
properties:
transaction:
type: object
properties:
txid:
type: string
example: 1b66c3d50dc32690a352f3cec78cd247d02a57a5c521865fb2a137785f129a7d
from:
type: string
example: TLkkCeNdJKPNUwucdro84WjswkzM62LCTH
to:
type: string
example: TUwmZghA7u2GxGxKaxM1mkCmsTF4wHs4vp
amount:
type: string
example: '1.000000'
blocknumber:
type: integer
example: 44700012
confirmations:
type: integer
example: 55416
type:
type: string
example: Tron
tags:
- 'Tron Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
/api/v2/tron/addresses:
post:
summary: 'Create Address'
operationId: createAddress
description: "Creates a new address wich can be used to send and receive crypto currencies, ERC20 and ERC721 tokens.\nplease provide a stron password within the request body. You will need the password everytime you interact with your address.\n\nThere are two ways to create an Address:\n- unsecure: You will directly get the private key of your address which can be used to create transactions\n- secure: You define a password, the privatekley will use this password as well as our own encryption chain to store the privatekey on our database. You can use this password instead of a private key to create transactions\n\n"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Address created'
type: object
example:
status: 201
ok: true
message: 'Address created'
data:
-
privateKey: 59f1c6200e01a2ca9471411f10198bfa63678d0e87cc2ca30f9c4a68dee78edc
publicKey: 040fe6e677442c36f7fdd5535ba3ff1cef0110d78363420f7e24b65298990e3467aed68b9a67e1396d84753db25b32a2fa3e1fc0a673f01638e9bcfab2d8f4ceb5
hexAddress: 41a56a6505ffbee78eb916dd44f4846874deddaebd
address: TR3qx91smURF3R455V1ubqtoUsZbgqikfg
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Address created'
data:
type: array
example:
-
privateKey: 59f1c6200e01a2ca9471411f10198bfa63678d0e87cc2ca30f9c4a68dee78edc
publicKey: 040fe6e677442c36f7fdd5535ba3ff1cef0110d78363420f7e24b65298990e3467aed68b9a67e1396d84753db25b32a2fa3e1fc0a673f01638e9bcfab2d8f4ceb5
hexAddress: 41a56a6505ffbee78eb916dd44f4846874deddaebd
address: TR3qx91smURF3R455V1ubqtoUsZbgqikfg
items:
type: object
properties:
privateKey:
type: string
example: 59f1c6200e01a2ca9471411f10198bfa63678d0e87cc2ca30f9c4a68dee78edc
publicKey:
type: string
example: 040fe6e677442c36f7fdd5535ba3ff1cef0110d78363420f7e24b65298990e3467aed68b9a67e1396d84753db25b32a2fa3e1fc0a673f01638e9bcfab2d8f4ceb5
hexAddress:
type: string
example: 41a56a6505ffbee78eb916dd44f4846874deddaebd
address:
type: string
example: TR3qx91smURF3R455V1ubqtoUsZbgqikfg
-
description: 'Secure Address created'
type: object
example:
status: 201
ok: true
message: 'Address created'
data:
address: TR3qx91smURF3R455V1ubqtoUsZbgqikfg
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Address created'
data:
type: object
properties:
address:
type: string
example: TR3qx91smURF3R455V1ubqtoUsZbgqikfg
tags:
- 'Tron Addresses'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
'/api/v2/tron/addresses/{address}':
delete:
summary: 'Delete Address'
operationId: deleteAddress
description: 'This method will delete your address. This decreases your used address metrics'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Address deleted'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Address deleted'
data:
type: array
example: []
tags:
- 'Tron Addresses'
post:
summary: 'Update Address Password'
operationId: updateAddressPassword
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Password updated'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Password updated'
data:
type: array
example: []
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- 'Tron Addresses'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
old_password:
type: string
description: 'The old password of the user.'
example: old_password123
new_password:
type: string
description: 'The new password of the user.'
example: new_password123
required:
- old_password
- new_password
parameters:
-
in: path
name: address
description: 'The address you want to delete.'
example: '0xd280406b68901ae4F2431d1830dF5232F49C19fA'
required: true
schema:
type: string
'/api/v2/tron/balances/{address}':
get:
summary: 'Get TRX balance'
operationId: getTRXBalance
description: 'This method returns the balance of the specified address'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Tron Blockchain Queries'
parameters:
-
in: path
name: address
description: 'The address to fetch the balance for'
example: TVF2Mp9QY7FEGTnr3DBpFLobA6jguHyMvi
required: true
schema:
type: string
'/api/v2/tron/balances/{address}/trc20/{contract_address}':
get:
summary: 'Get TRC20 balance'
operationId: getTRC20Balance
description: 'This method returns the balance of the specified address for the specified token'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'TRC20 balance fetched'
data:
tronaddress: TVF2Mp9QY7FEGTnr3DBpFLobA6jguHyMvi
decimals: 6
balance: '1000000000000000000'
contractaddress: TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'TRC20 balance fetched'
data:
type: object
properties:
tronaddress:
type: string
example: TVF2Mp9QY7FEGTnr3DBpFLobA6jguHyMvi
decimals:
type: integer
example: 6
balance:
type: string
example: '1000000000000000000'
contractaddress:
type: string
example: TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj
tags:
- 'Tron Blockchain Queries'
parameters:
-
in: path
name: address
description: 'The address to fetch the balance for'
example: TVF2Mp9QY7FEGTnr3DBpFLobA6jguHyMvi
required: true
schema:
type: string
-
in: path
name: contract_address
description: 'The contract address'
example: TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj
required: true
schema:
type: string
'/api/v2/tron/addresses/export/{address}':
post:
summary: ''
operationId: postApiV2TronAddressesExportAddress
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Private key exported'
data:
private_key: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Private key exported'
data:
type: object
properties:
private_key:
type: string
example: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- 'Tron Addresses'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
parameters:
-
in: path
name: address
description: ''
example: architecto
required: true
schema:
type: string
/api/v2/tron/addresses/import:
post:
summary: 'Import Private key'
operationId: importPrivateKey
description: 'Import a Private key to use the secure wallet functionality for transactions.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Address imported successfully'
data: []
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Address imported successfully'
data:
type: array
example: []
tags:
- 'Tron Addresses'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
address:
type: string
description: ''
example: architecto
privatekey:
type: string
description: ''
example: architecto
password:
type: string
description: ''
example: architecto
required:
- address
- privatekey
- password
/api/v2/tron/transactions/trc20:
post:
summary: 'Send TRC20 transaction'
operationId: sendTRC20Transaction
description: "This method creates a new TRC20 transaction.
\nIf the transaction is successful, it will return the transaction hash.
\nIf the transaction fails, it will return an error message.
"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created transaction'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created transaction'
data:
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created transaction'
data:
type: object
properties:
txid:
type: string
example: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Insufficent funds'
type: object
example:
status: 422
ok: false
message: 'class org.tron.core.exception.ContractValidateException : Validate TransferContract error, balance is not sufficient.'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'class org.tron.core.exception.ContractValidateException : Validate TransferContract error, balance is not sufficient.'
errors:
type: array
example: []
-
description: 'Wrong privatekey'
type: object
example:
status: 422
ok: false
message: 'Validate signature error: 0984bea42fc16d38512ef3f3ae0ad36b7123d1804a8b284106005793d441b2dd2d1bfdad10ec2879e06a35bbb9a89f268b81b79bc35f6031784c32fe60eee65e01 is signed by TT61CoyUW1ZwkcpkZAcortLvpYk7TW4fgD but it is not contained of permission.'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Validate signature error: 0984bea42fc16d38512ef3f3ae0ad36b7123d1804a8b284106005793d441b2dd2d1bfdad10ec2879e06a35bbb9a89f268b81b79bc35f6031784c32fe60eee65e01 is signed by TT61CoyUW1ZwkcpkZAcortLvpYk7TW4fgD but it is not contained of permission.'
errors:
type: array
example: []
tags:
- 'Tron Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from.'
example: TLkkCeNdJKPNUwucdro84WjswkzM62LCTH
to:
type: string
description: 'The address to send the transaction to.'
example: TUwmZghA7u2GxGxKaxM1mkCmsTF4wHs4vp
contractaddress:
type: string
description: 'The contract address of the token.'
example: 0x708c419d1b9ae123047f70787a503b6ba51e048a27966e0220cc5feXXXXXXXXX
amount:
type: number
description: 'The amount to send.'
example: 1.0
password:
type: string
description: 'The password to unlock the wallet if you working with a password protected wallet created with chaingateway. . This field is required when privatekey is not present.'
example: password123
privatekey:
type: string
description: 'The private key to sign the transaction, only needed if working with non-secure chaingateway wallet.'
example: '123456'
required:
- from
- to
- contractaddress
- amount
/api/v2/tron/transactions/trc721:
post:
summary: 'Send TRC721 transactions'
operationId: sendTRC721Transactions
description: "This method creates a new TRC721 transaction.
\nIf the transaction is successful, it will return the transaction hash.
\nIf the transaction fails, it will return an error message.
"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created transaction'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created transaction'
data:
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created transaction'
data:
type: object
properties:
txid:
type: string
example: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Insufficent funds'
type: object
example:
status: 422
ok: false
message: 'class org.tron.core.exception.ContractValidateException : Validate TransferContract error, balance is not sufficient.'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'class org.tron.core.exception.ContractValidateException : Validate TransferContract error, balance is not sufficient.'
errors:
type: array
example: []
-
description: 'Wrong privatekey'
type: object
example:
status: 422
ok: false
message: 'Validate signature error: 0984bea42fc16d38512ef3f3ae0ad36b7123d1804a8b284106005793d441b2dd2d1bfdad10ec2879e06a35bbb9a89f268b81b79bc35f6031784c32fe60eee65e01 is signed by TT61CoyUW1ZwkcpkZAcortLvpYk7TW4fgD but it is not contained of permission.'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Validate signature error: 0984bea42fc16d38512ef3f3ae0ad36b7123d1804a8b284106005793d441b2dd2d1bfdad10ec2879e06a35bbb9a89f268b81b79bc35f6031784c32fe60eee65e01 is signed by TT61CoyUW1ZwkcpkZAcortLvpYk7TW4fgD but it is not contained of permission.'
errors:
type: array
example: []
tags:
- 'Tron Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from.'
example: TLkkCeNdJKPNUwucdro84WjswkzM62LCTH
to:
type: string
description: 'The address to send the transaction to.'
example: TUwmZghA7u2GxGxKaxM1mkCmsTF4wHs4vp
contractaddress:
type: string
description: 'The contract address of the token.'
example: 0x708c419d1b9ae123047f70787a503b6ba51e048a27966e0220cc5feXXXXXXXXX
tokenid:
type: number
description: 'The token id of the token.'
example: 1.0
amount:
type: number
description: 'The amount to send.'
example: 1.0
password:
type: string
description: 'The password to unlock the wallet if you working with a password protected wallet created with chaingateway. . This field is required when privatekey is not present.'
example: password123
privatekey:
type: string
description: 'The private key to sign the transaction, only needed if working with non-secure chaingateway wallet.'
example: '0x123456'
required:
- from
- to
- contractaddress
- tokenid
- amount
'/api/v2/tron/trc20/{contract_address}':
get:
summary: 'Get TRC20 contract information'
operationId: getTRC20ContractInformation
description: 'This method returns the contract information of the specified contract'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'TRC20 contract fetched'
data:
address: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t
symbol: USDT
name: TetherUSD
totalSupply: '61742996582033118'
decimals: '6'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'TRC20 contract fetched'
data:
type: object
properties:
address:
type: string
example: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t
symbol:
type: string
example: USDT
name:
type: string
example: TetherUSD
totalSupply:
type: string
example: '61742996582033118'
decimals:
type: string
example: '6'
400:
description: ''
content:
application/json:
schema:
type: object
example:
status: 400
ok: false
message: 'Error fetching TRC20 contract'
data:
error: 'Contract not found'
properties:
status:
type: integer
example: 400
ok:
type: boolean
example: false
message:
type: string
example: 'Error fetching TRC20 contract'
data:
type: object
properties:
error:
type: string
example: 'Contract not found'
tags:
- 'Tron Blockchain Queries'
parameters:
-
in: path
name: contract_address
description: 'The contract address'
example: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t
required: true
schema:
type: string
'/api/v2/tron/transactions/{txid}/receipt/{decoded}':
get:
summary: 'Show Transaction Receipt'
operationId: showTransactionReceipt
description: 'This method shows a transaction receipt'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: Decoded
type: object
example:
status: 200
ok: true
message: 'Succesfully parsedtransaction receipt'
data:
transaction:
blockHash: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber: '37701506'
cumulativeGasUsed: '627702'
effectiveGasPrice: '3.0000000000'
from: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed: '21000'
logs: []
logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status: true
to: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex: '8'
type: '8'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsedtransaction receipt'
data:
type: object
properties:
transaction:
type: object
properties:
blockHash:
type: string
example: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber:
type: string
example: '37701506'
cumulativeGasUsed:
type: string
example: '627702'
effectiveGasPrice:
type: string
example: '3.0000000000'
from:
type: string
example: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed:
type: string
example: '21000'
logs:
type: array
example: []
logsBloom:
type: string
example: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status:
type: boolean
example: true
to:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex:
type: string
example: '8'
type:
type: string
example: '8'
-
description: Encoded
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction receipt'
data:
transaction:
blockHash: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber: '0x23f4782'
contractAddress: null
cumulativeGasUsed: '0x993f6'
effectiveGasPrice: '0xb2d05e00'
from: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed: '0x5208'
logs: []
logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status: '0x1'
to: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex: '0x8'
type: '0x0'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction receipt'
data:
type: object
properties:
transaction:
type: object
properties:
blockHash:
type: string
example: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber:
type: string
example: '0x23f4782'
contractAddress:
type: string
example: null
cumulativeGasUsed:
type: string
example: '0x993f6'
effectiveGasPrice:
type: string
example: '0xb2d05e00'
from:
type: string
example: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed:
type: string
example: '0x5208'
logs:
type: array
example: []
logsBloom:
type: string
example: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status:
type: string
example: '0x1'
to:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex:
type: string
example: '0x8'
type:
type: string
example: '0x0'
422:
description: 'Transaction receipt not found'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'transaction not found'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'transaction not found'
errors:
type: array
example: []
tags:
- 'Tron Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
-
in: path
name: decoded
description: "Optional parameter. If set to 'decoded' it will return the decoded transaction"
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: decoded
'/api/v2/tron/balances/{address}/trc10/{token_id}':
get:
summary: 'Get TRC10 balance'
operationId: getTRC10Balance
description: 'This method returns the balance of the specified address for the specified token'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'TRC10 balance fetched'
data:
tronaddress: TTbxaUNHATeKRX4vCpLayeUA4eWJDG2KYS
decimals: 2
balance: '17990'
tokenid: '1002357'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'TRC10 balance fetched'
data:
type: object
properties:
tronaddress:
type: string
example: TTbxaUNHATeKRX4vCpLayeUA4eWJDG2KYS
decimals:
type: integer
example: 2
balance:
type: string
example: '17990'
tokenid:
type: string
example: '1002357'
tags:
- 'Tron Blockchain Queries'
parameters:
-
in: path
name: address
description: 'The address to fetch the balance for'
example: TTbxaUNHATeKRX4vCpLayeUA4eWJDG2KYS
required: true
schema:
type: string
-
in: path
name: token_id
description: 'The token id'
example: '1002357'
required: true
schema:
type: string
/api/v2/tron/freeze:
post:
summary: 'Freeze balance'
operationId: freezeBalance
description: "Freezing is used to obtain resources, such as Bandwidth and Energy, which are required to perform transactions on the Tron network. Freezing balance is a requirement for delegating resources to other addresses.\nTo ensure proper freezing of balance, you need to ensure that you have enough balance to freeze"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Freezed balance'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Balance frozen'
data:
result: true
txid: 9a0799630a4523b2caa5855b172ad75a5dfac9589a20441e7fe0622816c29023
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Balance frozen'
data:
type: object
properties:
result:
type: boolean
example: true
txid:
type: string
example: 9a0799630a4523b2caa5855b172ad75a5dfac9589a20441e7fe0622816c29023
422:
description: 'Freezing failed'
content:
application/json:
schema:
type: object
example:
status: 422
message: 'Freezing failed'
errors: []
properties:
status:
type: integer
example: 422
message:
type: string
example: 'Freezing failed'
errors:
type: array
example: []
tags:
- 'Tron Staking'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
address:
type: string
description: 'Must match the regex /^T[1-9A-HJ-NP-Za-km-z]{33}$/.'
example: TVQzpd28yXB1ETsf5NMZMHjvvAE3LXEDAK
amount:
type: number
description: ''
example: 100.0
resource:
type: string
description: ''
example: ENERGY
enum:
- BANDWIDTH
- ENERGY
password:
type: string
description: 'The password for the address. This field is required when privatekey is not present.'
example: your_password
privatekey:
type: string
description: 'The private key of the sender.'
example: 708c419d1b9ae123047f70787a503b6ba51e048a27966e0220cc5feXXXXXXXXX
required:
- address
- amount
- resource
/api/v2/tron/unfreeze:
post:
summary: 'Unfreeze balance'
operationId: unfreezeBalance
description: "Unfreezing is used to release resources, such as Bandwidth and Energy, which are required to perform transactions on the Tron network. Unfreezing balance is a requirement for delegating resources to other addresses.\nTo ensure proper unfreezing of balance, you need to ensure that you already freezed balance to this address"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Unfreezed balance'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Balance unfrozen'
data:
result: true
txid: c78d5946c9718f763c8a19e4f3dffedefd6319df5bfc337cb5a3d19f03f2cbcd
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Balance unfrozen'
data:
type: object
properties:
result:
type: boolean
example: true
txid:
type: string
example: c78d5946c9718f763c8a19e4f3dffedefd6319df5bfc337cb5a3d19f03f2cbcd
422:
description: 'Freezing failed'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'class org.tron.core.exception.ContractValidateException : no frozenBalance(Energy)'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'class org.tron.core.exception.ContractValidateException : no frozenBalance(Energy)'
errors:
type: array
example: []
tags:
- 'Tron Staking'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
address:
type: string
description: 'Must match the regex /^T[1-9A-HJ-NP-Za-km-z]{33}$/.'
example: TVQzpd28yXB1ETsf5NMZMHjvvAE3LXEDAK
amount:
type: number
description: ''
example: 100.0
resource:
type: string
description: ''
example: ENERGY
enum:
- BANDWIDTH
- ENERGY
password:
type: string
description: 'The password for the address. This field is required when privatekey is not present.'
example: your_password
privatekey:
type: string
description: 'The private key of the sender.'
example: 708c419d1b9ae123047f70787a503b6ba51e048a27966e0220cc5feXXXXXXXXX
required:
- address
- amount
- resource
/api/v2/tron/delegate:
post:
summary: 'Delegate ressources'
operationId: delegateRessources
description: "Delegation is used to delegate resources, such as Bandwidth and Energy, to other addresses. Delegating balance is a requirement for voting for Super Representatives and obtaining rewards.\nTo ensure proper delegation of balance, it is important to follow two rules. First, the delegated balance needs to be frozen before delegation can occur. Second, the receiver address should not be the same as the owner address. These rules help maintain the integrity and security of the delegation process."
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: Delegated
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: Delegated
data:
result: true
txid: 08a9de94df7ff9e0983a91013921f4ff170c42d9b6b6f034d54228502cfe3809
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: Delegated
data:
type: object
properties:
result:
type: boolean
example: true
txid:
type: string
example: 08a9de94df7ff9e0983a91013921f4ff170c42d9b6b6f034d54228502cfe3809
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Not enough freezed balance'
type: object
example:
status: 422
ok: false
message: 'class org.tron.core.exception.ContractValidateException : delegateBalance must be less than or equal to available FreezeEnergyV2 balance'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'class org.tron.core.exception.ContractValidateException : delegateBalance must be less than or equal to available FreezeEnergyV2 balance'
errors:
type: array
example: []
-
description: 'Receiver same as owner'
type: object
example:
status: 422
ok: false
message: 'class org.tron.core.exception.ContractValidateException : receiverAddress must not be the same as ownerAddress'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'class org.tron.core.exception.ContractValidateException : receiverAddress must not be the same as ownerAddress'
errors:
type: array
example: []
tags:
- 'Tron Staking'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
address:
type: string
description: 'Must match the regex /^T[1-9A-HJ-NP-Za-km-z]{33}$/.'
example: TVQzpd28yXB1ETsf5NMZMHjvvAE3LXEDAK
amount:
type: number
description: ''
example: 100.0
receiver:
type: string
description: ''
example: TVQzpd28yXB1ETsf5NMZMHjvvAE3LXEDAK
resource:
type: string
description: ''
example: ENERGY
enum:
- BANDWIDTH
- ENERGY
password:
type: string
description: 'The password for the address. This field is required when privatekey is not present.'
example: your_password
privatekey:
type: string
description: 'The private key of the sender.'
example: 708c419d1b9ae123047f70787a503b6ba51e048a27966e0220cc5feXXXXXXXXX
required:
- address
- amount
- receiver
- resource
/api/v2/tron/undelegate:
post:
summary: 'Undelegate ressources'
operationId: undelegateRessources
description: "Undelegation is used to release delegated resources, such as Bandwidth and Energy, which are required to perform transactions on the Tron network. Undelegating balance is a requirement for voting for Super Representatives and obtaining rewards.\nTo ensure proper delegation of balance, you need to ensure that you already delegated ressources to this address"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: Undelegated
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: Undelegated
data:
result: true
txid: 5b95fc968984975a4dac5cf5a82b9c265ffae1fc1d227a7c2be5ab4ff74d3ecb
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: Undelegated
data:
type: object
properties:
result:
type: boolean
example: true
txid:
type: string
example: 5b95fc968984975a4dac5cf5a82b9c265ffae1fc1d227a7c2be5ab4ff74d3ecb
422:
description: 'Not enough freezed balance'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'class org.tron.core.exception.ContractValidateException : delegated Resource does not exist'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'class org.tron.core.exception.ContractValidateException : delegated Resource does not exist'
errors:
type: array
example: []
tags:
- 'Tron Staking'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
address:
type: string
description: 'Must match the regex /^T[1-9A-HJ-NP-Za-km-z]{33}$/.'
example: TVQzpd28yXB1ETsf5NMZMHjvvAE3LXEDAK
amount:
type: number
description: ''
example: 100.0
receiver:
type: string
description: ''
example: TVQzpd28yXB1ETsf5NMZMHjvvAE3LXEDAK
resource:
type: string
description: ''
example: ENERGY
enum:
- BANDWIDTH
- ENERGY
password:
type: string
description: 'The password for the address. This field is required when privatekey is not present.'
example: your_password
privatekey:
type: string
description: 'The private key of the sender.'
example: 708c419d1b9ae123047f70787a503b6ba51e048a27966e0220cc5feXXXXXXXXX
required:
- address
- amount
- receiver
- resource
/api/v2/tron/chainparameters:
get:
summary: 'Get chain parameters'
operationId: getChainParameters
description: 'This method returns the chain parameters of the Tron blockchain'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Chain parameters fetched'
data:
chainParameter:
-
key: getMaintenanceTimeInterval
value: 21600000
-
key: getAccountUpgradeCost
value: 9999000000
-
key: getCreateAccountFee
value: 100000
-
key: getTransactionFee
value: 1000
-
key: getAssetIssueFee
value: 1024000000
-
key: getWitnessPayPerBlock
value: 16000000
-
key: getWitnessStandbyAllowance
value: 100000000
-
key: getCreateNewAccountFeeInSystemContract
value: 1000000
-
key: getCreateNewAccountBandwidthRate
value: 1
-
key: getAllowCreationOfContracts
value: 1
-
key: getRemoveThePowerOfTheGr
value: -1
-
key: getEnergyFee
value: 420
-
key: getExchangeCreateFee
value: 1024000000
-
key: getMaxCpuTimeOfOneTx
value: 160
-
key: getAllowUpdateAccountName
-
key: getAllowSameTokenName
value: 1
-
key: getAllowDelegateResource
value: 1
-
key: getTotalEnergyLimit
value: 90000000000
-
key: getAllowTvmTransferTrc10
value: 1
-
key: getTotalEnergyCurrentLimit
value: 90000000000
-
key: getAllowMultiSign
value: 1
-
key: getAllowAdaptiveEnergy
-
key: getTotalEnergyTargetLimit
value: 6250000
-
key: getTotalEnergyAverageUsage
-
key: getUpdateAccountPermissionFee
value: 100000000
-
key: getMultiSignFee
value: 1000000
-
key: getAllowAccountStateRoot
-
key: getAllowProtoFilterNum
-
key: getAllowTvmConstantinople
value: 1
-
key: getAllowTvmSolidity059
value: 1
-
key: getAllowTvmIstanbul
value: 1
-
key: getAllowShieldedTRC20Transaction
value: 1
-
key: getForbidTransferToContract
-
key: getAdaptiveResourceLimitTargetRatio
value: 10
-
key: getAdaptiveResourceLimitMultiplier
value: 1000
-
key: getChangeDelegation
value: 1
-
key: getWitness127PayPerBlock
value: 10000000
-
key: getAllowMarketTransaction
value: 1
-
key: getMarketSellFee
-
key: getMarketCancelFee
-
key: getAllowPBFT
value: 1
-
key: getAllowTransactionFeePool
value: 1
-
key: getMaxFeeLimit
value: 15000000000
-
key: getAllowOptimizeBlackHole
value: 1
-
key: getAllowNewResourceModel
-
key: getAllowTvmFreeze
value: 1
-
key: getAllowTvmVote
value: 1
-
key: getAllowTvmLondon
value: 1
-
key: getAllowTvmCompatibleEvm
-
key: getAllowAccountAssetOptimization
-
key: getFreeNetLimit
value: 600
-
key: getTotalNetLimit
value: 43200000000
-
key: getAllowHigherLimitForMaxCpuTimeOfOneTx
value: 1
-
key: getAllowAssetOptimization
value: 1
-
key: getAllowNewReward
value: 1
-
key: getMemoFee
value: 1000000
-
key: getAllowDelegateOptimization
value: 1
-
key: getUnfreezeDelayDays
value: 14
-
key: getAllowOptimizedReturnValueOfChainId
value: 1
-
key: getAllowDynamicEnergy
value: 1
-
key: getDynamicEnergyThreshold
value: 3000000000
-
key: getDynamicEnergyIncreaseFactor
value: 2000
-
key: getDynamicEnergyMaxFactor
value: 12000
-
key: getAllowTvmShangHai
value: 1
-
key: getAllowCancelAllUnfreezeV2
value: 1
-
key: getMaxDelegateLockPeriod
value: 144000
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Chain parameters fetched'
data:
type: object
properties:
chainParameter:
type: array
example:
-
key: getMaintenanceTimeInterval
value: 21600000
-
key: getAccountUpgradeCost
value: 9999000000
-
key: getCreateAccountFee
value: 100000
-
key: getTransactionFee
value: 1000
-
key: getAssetIssueFee
value: 1024000000
-
key: getWitnessPayPerBlock
value: 16000000
-
key: getWitnessStandbyAllowance
value: 100000000
-
key: getCreateNewAccountFeeInSystemContract
value: 1000000
-
key: getCreateNewAccountBandwidthRate
value: 1
-
key: getAllowCreationOfContracts
value: 1
-
key: getRemoveThePowerOfTheGr
value: -1
-
key: getEnergyFee
value: 420
-
key: getExchangeCreateFee
value: 1024000000
-
key: getMaxCpuTimeOfOneTx
value: 160
-
key: getAllowUpdateAccountName
-
key: getAllowSameTokenName
value: 1
-
key: getAllowDelegateResource
value: 1
-
key: getTotalEnergyLimit
value: 90000000000
-
key: getAllowTvmTransferTrc10
value: 1
-
key: getTotalEnergyCurrentLimit
value: 90000000000
-
key: getAllowMultiSign
value: 1
-
key: getAllowAdaptiveEnergy
-
key: getTotalEnergyTargetLimit
value: 6250000
-
key: getTotalEnergyAverageUsage
-
key: getUpdateAccountPermissionFee
value: 100000000
-
key: getMultiSignFee
value: 1000000
-
key: getAllowAccountStateRoot
-
key: getAllowProtoFilterNum
-
key: getAllowTvmConstantinople
value: 1
-
key: getAllowTvmSolidity059
value: 1
-
key: getAllowTvmIstanbul
value: 1
-
key: getAllowShieldedTRC20Transaction
value: 1
-
key: getForbidTransferToContract
-
key: getAdaptiveResourceLimitTargetRatio
value: 10
-
key: getAdaptiveResourceLimitMultiplier
value: 1000
-
key: getChangeDelegation
value: 1
-
key: getWitness127PayPerBlock
value: 10000000
-
key: getAllowMarketTransaction
value: 1
-
key: getMarketSellFee
-
key: getMarketCancelFee
-
key: getAllowPBFT
value: 1
-
key: getAllowTransactionFeePool
value: 1
-
key: getMaxFeeLimit
value: 15000000000
-
key: getAllowOptimizeBlackHole
value: 1
-
key: getAllowNewResourceModel
-
key: getAllowTvmFreeze
value: 1
-
key: getAllowTvmVote
value: 1
-
key: getAllowTvmLondon
value: 1
-
key: getAllowTvmCompatibleEvm
-
key: getAllowAccountAssetOptimization
-
key: getFreeNetLimit
value: 600
-
key: getTotalNetLimit
value: 43200000000
-
key: getAllowHigherLimitForMaxCpuTimeOfOneTx
value: 1
-
key: getAllowAssetOptimization
value: 1
-
key: getAllowNewReward
value: 1
-
key: getMemoFee
value: 1000000
-
key: getAllowDelegateOptimization
value: 1
-
key: getUnfreezeDelayDays
value: 14
-
key: getAllowOptimizedReturnValueOfChainId
value: 1
-
key: getAllowDynamicEnergy
value: 1
-
key: getDynamicEnergyThreshold
value: 3000000000
-
key: getDynamicEnergyIncreaseFactor
value: 2000
-
key: getDynamicEnergyMaxFactor
value: 12000
-
key: getAllowTvmShangHai
value: 1
-
key: getAllowCancelAllUnfreezeV2
value: 1
-
key: getMaxDelegateLockPeriod
value: 144000
items:
type: object
properties:
key:
type: string
example: getMaintenanceTimeInterval
value:
type: integer
example: 21600000
tags:
- 'Tron Blockchain Queries'
/api/v2/tron/transactions/trc10:
post:
summary: 'Send TRC10 transaction'
operationId: sendTRC10Transaction
description: "This method creates a new ERC10 transaction.
\nIf the transaction is successful, it will return the transaction hash.
\nIf the transaction fails, it will return an error message.
"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created transaction'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created transaction'
data:
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created transaction'
data:
type: object
properties:
txid:
type: string
example: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Insufficent funds'
type: object
example:
status: 422
ok: false
message: 'class org.tron.core.exception.ContractValidateException : Validate TransferContract error, balance is not sufficient.'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'class org.tron.core.exception.ContractValidateException : Validate TransferContract error, balance is not sufficient.'
errors:
type: array
example: []
-
description: 'Wrong privatekey'
type: object
example:
status: 422
ok: false
message: 'Validate signature error: 0984bea42fc16d38512ef3f3ae0ad36b7123d1804a8b284106005793d441b2dd2d1bfdad10ec2879e06a35bbb9a89f268b81b79bc35f6031784c32fe60eee65e01 is signed by TT61CoyUW1ZwkcpkZAcortLvpYk7TW4fgD but it is not contained of permission.'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Validate signature error: 0984bea42fc16d38512ef3f3ae0ad36b7123d1804a8b284106005793d441b2dd2d1bfdad10ec2879e06a35bbb9a89f268b81b79bc35f6031784c32fe60eee65e01 is signed by TT61CoyUW1ZwkcpkZAcortLvpYk7TW4fgD but it is not contained of permission.'
errors:
type: array
example: []
tags:
- 'Tron Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from.'
example: TLkkCeNdJKPNUwucdro84WjswkzM62LCTH
to:
type: string
description: 'The address to send the transaction to.'
example: TUwmZghA7u2GxGxKaxM1mkCmsTF4wHs4vp
tokenId:
type: string
description: 'The id of the token.'
example: '1004920'
amount:
type: number
description: 'The amount to send.'
example: 1.0
password:
type: string
description: 'The password to unlock the wallet if you working with a password protected wallet created with chaingateway. . This field is required when privatekey is not present.'
example: password123
privatekey:
type: string
description: 'The private key to sign the transaction, only needed if working with non-secure chaingateway wallet.'
example: '0x123456'
required:
- from
- to
- tokenId
- amount
/api/v2/tron/transactions/broadcast:
post:
summary: 'Broadcast transaction (self signing)'
operationId: broadcastTransactionselfSigning
description: 'If you sign the transaction by yourself, you can broadcast it using this endpoint'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully broadcasted transaction'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully broadcasted transaction'
data:
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully broadcasted transaction'
data:
type: object
properties:
txid:
type: string
example: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Insufficent funds'
type: object
example:
status: 422
ok: false
message: 'class org.tron.core.exception.ContractValidateException : Validate TransferContract error, balance is not sufficient.'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'class org.tron.core.exception.ContractValidateException : Validate TransferContract error, balance is not sufficient.'
errors:
type: array
example: []
-
description: 'Wrong privatekey'
type: object
example:
status: 422
ok: false
message: 'Validate signature error: 0984bea42fc16d38512ef3f3ae0ad36b7123d1804a8b284106005793d441b2dd2d1bfdad10ec2879e06a35bbb9a89f268b81b79bc35f6031784c32fe60eee65e01 is signed by TT61CoyUW1ZwkcpkZAcortLvpYk7TW4fgD but it is not contained of permission.'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Validate signature error: 0984bea42fc16d38512ef3f3ae0ad36b7123d1804a8b284106005793d441b2dd2d1bfdad10ec2879e06a35bbb9a89f268b81b79bc35f6031784c32fe60eee65e01 is signed by TT61CoyUW1ZwkcpkZAcortLvpYk7TW4fgD but it is not contained of permission.'
errors:
type: array
example: []
tags:
- 'Tron Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
signed_transaction:
type: string
description: 'Must be a valid JSON string.'
example: '{"visible":true,"txID":"72d38aa982831fb6a7c6ea27ea063311ea3e1cb8749b0b2b461f9bb64ec1ddce","raw_data":{"contract":[{"parameter":{"value":{"amount":50000000,"owner_address":"TD5QjXcKdS8yhG2uwSgxvbQFdK69ycH8D7","to_address":"TXbhwYpomVzyU3MjZdFTJk1LV29zm8r9nG"},"type_url":"type.googleapis.com\/protocol.TransferContract"},"type":"TransferContract"}],"ref_block_bytes":"1d60","ref_block_hash":"86e0e9ec4b2246b0","expiration":1736841987000,"timestamp":1736841930419},"raw_data_hex":"0a021d60220886e0e9ec4b2246b040b887e69ec6325a68080112640a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412330a15412214aaacb1e425bc3d077b8d2095f4a84c705b7d121541ed41c607af110fe24900767601c4f61bb047b3f71880e1eb1770b3cde29ec632","signature":["1eff4117e4658b506dec54c6a28cfbba25b347d00862a557da949b8315235e53a9ffaf1f3b99184d5c7bbb4f64e51c4e3bf45b40d8dded41076477f2319ef15e00"]}'
required:
- signed_transaction
/api/v2/tron/paymaster:
post:
summary: 'Create Paymaster Request'
operationId: createPaymasterRequest
description: 'This endpoint is used to create a new paymaster request.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Succesfully created paymaster requests'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully created paymaster request'
data:
id: 9c72d676-8180-4cd2-a406-f0f1cd097506
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully created paymaster request'
data:
type: object
properties:
id:
type: string
example: 9c72d676-8180-4cd2-a406-f0f1cd097506
tags:
- 'Tron Paymaster'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: 'The type of transaction.'
example: TRC20
enum:
- TRX
- TRC10
- TRC20
- TRC721
from:
type: string
description: 'The address to send the transaction from.'
example: TLkkCeNdJKPNUwucdro84WjswkzM62LCTH
to:
type: string
description: 'The address to send the transaction to.'
example: TUwmZghA7u2GxGxKaxM1mkCmsTF4wHs4vp
contractaddress:
type: string
description: 'The contract address of the token. This field is required when type is TRC20 or TRC721.'
example: 0x708c419d1b9ae123047f70787a503b6ba51e048a27966e0220cc5feXXXXXXXXX
tokenid:
type: number
description: 'The token id of the token. This field is required when type is TRC721 or TRC10.'
example: 1.0
amount:
type: string
description: 'The amount to send.'
example: '1'
password:
type: string
description: 'The password for the address. This field is required when privatekey is not present.'
example: your_password
privatekey:
type: string
description: 'The private key of the sender.'
example: 708c419d1b9ae123047f70787a503b6ba51e048a27966e0220cc5feXXXXXXXXX
callback_url:
type: string
description: 'The callback url to send the response to.'
example: 'https://example.com/callback'
required:
- type
- from
- to
- amount
get:
summary: 'Display all Paymaster Requests.'
operationId: displayAllPaymasterRequests
description: "The status is indicating the status of the request. Possible values are:\npending: the request is pending\nprocessing: the request is processing. We wait for a successful transaction.\ncompleted: the request is completed\nfailed - [reason]: the request failed, the string behind the dash shows the reason.\n\nAs soon as as the transaction is completed, you will see the resulted transaction in the response parameter 'txid'"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Succesfully Parsed paymaster requests'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully Parsed paymaster requests'
current_page: 1
data:
-
id: 9cfbfcaf-68b2-47e9-bf55-5b6b4875e84d
type: TRC20
from: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
to: TPUjdnMrS7XDUFp5W6zgh4QDCW34nXa2x1
contract_address: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t
amount: '200'
token_id: null
transaction_hash: 80a223e0cb20ef692fbd23d3cbaf3cc1dfa2b9667aaef70c7da8ca8f707ec28b
status: success
used_credits: '2.178413'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-11T15:28:57.000000Z'
-
id: 9cfbfff2-a5ca-4268-a219-a7554ecf9fd0
type: TRC20
from: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
to: TPUjdnMrS7XDUFp5W6zgh4QDCW34nXa2x1
contract_address: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t
amount: '2832.001791'
token_id: null
transaction_hash: f97400998a9676c6f7a1e5271ef5fbd30eac25d012634ac56e87505c8651fe5d
status: success
used_credits: '1.154359'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-11T13:30:48.000000Z'
-
id: 9cfa0b7a-1fa5-4197-854e-d66fec5a8cb9
type: TRX
from: TTfLc34WGv3RrdEV3WyexrwdkedrFhtqGq
to: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
contract_address: null
amount: '200'
token_id: null
transaction_hash: 6ed5ede9898ac4f7f7ab60225e6183e674b7c29b5b1384712958f67f14ea411b
status: success
used_credits: '0.0804'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-10T14:11:23.000000Z'
-
id: 9cfa0964-3e1c-4139-9e5e-ec3f51117da7
type: TRX
from: TRW4pjnfBnJ7u9gfhdHzQYhtqnJEYX68Qn
to: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
contract_address: null
amount: '200'
token_id: null
transaction_hash: 1ac9ec5ba6fb88aa037c70eff26be46a4c95f19c1fb3ab20c4d630a376bbb1da
status: success
used_credits: '0.0804'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-10T14:05:33.000000Z'
-
id: 9cfa090d-c4a1-4c07-9f32-05eec2ccd9ec
type: TRX
from: TRW4pjnfBnJ7u9gfhdHzQYhtqnJEYX68Qn
to: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
contract_address: null
amount: '200'
token_id: null
transaction_hash: null
status: failed
used_credits: '0.0804'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-10T14:04:36.000000Z'
-
id: 9cfa08d5-c435-41a3-92d3-881fe1a0d56c
type: TRX
from: TRW4pjnfBnJ7u9gfhdHzQYhtqnJEYX68Qn
to: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
contract_address: null
amount: '200'
token_id: null
transaction_hash: null
status: failed
used_credits: '0.0804'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-10T14:03:59.000000Z'
-
id: 9cfa0264-d6ab-46fa-a82b-41a32264c3a8
type: TRX
from: TRW4pjnfBnJ7u9gfhdHzQYhtqnJEYX68Qn
to: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
contract_address: null
amount: '200'
token_id: null
transaction_hash: null
status: failed
used_credits: '0.0804'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-10T13:45:59.000000Z'
-
id: 9cfa0021-5203-4b69-9836-8447b120723b
type: TRX
from: TRW4pjnfBnJ7u9gfhdHzQYhtqnJEYX68Qn
to: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
contract_address: null
amount: '200'
token_id: null
transaction_hash: null
status: failed
used_credits: '0.0804'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-10T13:39:39.000000Z'
-
id: 9cd3d9a3-191b-4107-a358-396be363cfc3
type: TRC20
from: TM7QnQtPGAyMGokd3KjKdTpKjFUgTHW7pP
to: TXLd9QHrGF4Kvm4eng1hCcCFoqUGQKBH43
contract_address: TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj
amount: '10'
token_id: null
transaction_hash: 9aa115693113c0a1f980f6f4bc8307fb157467792668e076adf7616289204376
status: success
used_credits: '0'
callback_url: null
created_at: '2024-08-22T14:30:33.000000Z'
-
id: 9cd36b3a-cd4e-40f9-8388-6e325e782c49
type: TRC20
from: TM7QnQtPGAyMGokd3KjKdTpKjFUgTHW7pP
to: TXLd9QHrGF4Kvm4eng1hCcCFoqUGQKBH43
contract_address: TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj
amount: '10'
token_id: null
transaction_hash: null
status: failed
used_credits: '0'
callback_url: null
created_at: '2024-08-22T09:21:50.000000Z'
first_page_url: 'http://chaingateway.test:81/api/v2/tron/paymaster?page=1'
from: 1
last_page: 1
last_page_url: 'http://chaingateway.test:81/api/v2/tron/paymaster?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://chaingateway.test:81/api/v2/tron/paymaster?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://chaingateway.test:81/api/v2/tron/paymaster'
per_page: 50
prev_page_url: null
to: 10
total: 10
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully Parsed paymaster requests'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 9cfbfcaf-68b2-47e9-bf55-5b6b4875e84d
type: TRC20
from: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
to: TPUjdnMrS7XDUFp5W6zgh4QDCW34nXa2x1
contract_address: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t
amount: '200'
token_id: null
transaction_hash: 80a223e0cb20ef692fbd23d3cbaf3cc1dfa2b9667aaef70c7da8ca8f707ec28b
status: success
used_credits: '2.178413'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-11T15:28:57.000000Z'
-
id: 9cfbfff2-a5ca-4268-a219-a7554ecf9fd0
type: TRC20
from: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
to: TPUjdnMrS7XDUFp5W6zgh4QDCW34nXa2x1
contract_address: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t
amount: '2832.001791'
token_id: null
transaction_hash: f97400998a9676c6f7a1e5271ef5fbd30eac25d012634ac56e87505c8651fe5d
status: success
used_credits: '1.154359'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-11T13:30:48.000000Z'
-
id: 9cfa0b7a-1fa5-4197-854e-d66fec5a8cb9
type: TRX
from: TTfLc34WGv3RrdEV3WyexrwdkedrFhtqGq
to: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
contract_address: null
amount: '200'
token_id: null
transaction_hash: 6ed5ede9898ac4f7f7ab60225e6183e674b7c29b5b1384712958f67f14ea411b
status: success
used_credits: '0.0804'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-10T14:11:23.000000Z'
-
id: 9cfa0964-3e1c-4139-9e5e-ec3f51117da7
type: TRX
from: TRW4pjnfBnJ7u9gfhdHzQYhtqnJEYX68Qn
to: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
contract_address: null
amount: '200'
token_id: null
transaction_hash: 1ac9ec5ba6fb88aa037c70eff26be46a4c95f19c1fb3ab20c4d630a376bbb1da
status: success
used_credits: '0.0804'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-10T14:05:33.000000Z'
-
id: 9cfa090d-c4a1-4c07-9f32-05eec2ccd9ec
type: TRX
from: TRW4pjnfBnJ7u9gfhdHzQYhtqnJEYX68Qn
to: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
contract_address: null
amount: '200'
token_id: null
transaction_hash: null
status: failed
used_credits: '0.0804'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-10T14:04:36.000000Z'
-
id: 9cfa08d5-c435-41a3-92d3-881fe1a0d56c
type: TRX
from: TRW4pjnfBnJ7u9gfhdHzQYhtqnJEYX68Qn
to: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
contract_address: null
amount: '200'
token_id: null
transaction_hash: null
status: failed
used_credits: '0.0804'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-10T14:03:59.000000Z'
-
id: 9cfa0264-d6ab-46fa-a82b-41a32264c3a8
type: TRX
from: TRW4pjnfBnJ7u9gfhdHzQYhtqnJEYX68Qn
to: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
contract_address: null
amount: '200'
token_id: null
transaction_hash: null
status: failed
used_credits: '0.0804'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-10T13:45:59.000000Z'
-
id: 9cfa0021-5203-4b69-9836-8447b120723b
type: TRX
from: TRW4pjnfBnJ7u9gfhdHzQYhtqnJEYX68Qn
to: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
contract_address: null
amount: '200'
token_id: null
transaction_hash: null
status: failed
used_credits: '0.0804'
callback_url: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at: '2024-09-10T13:39:39.000000Z'
-
id: 9cd3d9a3-191b-4107-a358-396be363cfc3
type: TRC20
from: TM7QnQtPGAyMGokd3KjKdTpKjFUgTHW7pP
to: TXLd9QHrGF4Kvm4eng1hCcCFoqUGQKBH43
contract_address: TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj
amount: '10'
token_id: null
transaction_hash: 9aa115693113c0a1f980f6f4bc8307fb157467792668e076adf7616289204376
status: success
used_credits: '0'
callback_url: null
created_at: '2024-08-22T14:30:33.000000Z'
-
id: 9cd36b3a-cd4e-40f9-8388-6e325e782c49
type: TRC20
from: TM7QnQtPGAyMGokd3KjKdTpKjFUgTHW7pP
to: TXLd9QHrGF4Kvm4eng1hCcCFoqUGQKBH43
contract_address: TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj
amount: '10'
token_id: null
transaction_hash: null
status: failed
used_credits: '0'
callback_url: null
created_at: '2024-08-22T09:21:50.000000Z'
items:
type: object
properties:
id:
type: string
example: 9cfbfcaf-68b2-47e9-bf55-5b6b4875e84d
type:
type: string
example: TRC20
from:
type: string
example: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
to:
type: string
example: TPUjdnMrS7XDUFp5W6zgh4QDCW34nXa2x1
contract_address:
type: string
example: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t
amount:
type: string
example: '200'
token_id:
type: string
example: null
transaction_hash:
type: string
example: 80a223e0cb20ef692fbd23d3cbaf3cc1dfa2b9667aaef70c7da8ca8f707ec28b
status:
type: string
example: success
used_credits:
type: string
example: '2.178413'
callback_url:
type: string
example: 'https://api.chaingateway.io/receiver/webhooks/tron'
created_at:
type: string
example: '2024-09-11T15:28:57.000000Z'
first_page_url:
type: string
example: 'http://chaingateway.test:81/api/v2/tron/paymaster?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://chaingateway.test:81/api/v2/tron/paymaster?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://chaingateway.test:81/api/v2/tron/paymaster?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://chaingateway.test:81/api/v2/tron/paymaster'
per_page:
type: integer
example: 50
prev_page_url:
type: string
example: null
to:
type: integer
example: 10
total:
type: integer
example: 10
tags:
- 'Tron Paymaster'
/api/v2/tron/paymaster/balance:
get:
summary: 'Get Paymaster Credit Balance'
operationId: getPaymasterCreditBalance
description: 'This endpoint is used to get the credit balance of the user.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Successfully fetched user balance'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully fetched user balance'
data:
balance: '100.00'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully fetched user balance'
data:
type: object
properties:
balance:
type: string
example: '100.00'
tags:
- 'Tron Paymaster'
'/api/v2/tron/paymaster/{id}':
get:
summary: 'Display the specified resource.'
operationId: displayTheSpecifiedResource
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Succesfully parsed paymaster requests'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully parsed paymaster request'
data:
id: 9cfbfff2-a5ca-4268-a219-a7554ecf9fd0
type: TRC20
status: success
from: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
to: TPUjdnMrS7XDUFp5W6zgh4QDCW34nXa2x1
contract_address: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t
token_id: null
amount: '2832.001791'
url: 'https://api.chaingateway.io/receiver/webhooks/tron'
used_credits: '1.154359'
logs:
- 'Successfully sent TRX for bandwidth to THG9nncwASg3ub5rvVquocAHwwQbnKZxpH: e7205c6b64e3fb10262d5e235e4b08ba8ac22df5f0b39bf4be572f2263d19ed4'
- 'Energy purchased successfully'
- 'enough Resources: false'
- 'timeout reached: false'
- 'callback response: 200'
- 'enough Resources: true'
- 'callback response: 200'
created_at: '2024-09-11T13:30:48.000000Z'
updated_at: '2024-09-11T13:31:26.000000Z'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully parsed paymaster request'
data:
type: object
properties:
id:
type: string
example: 9cfbfff2-a5ca-4268-a219-a7554ecf9fd0
type:
type: string
example: TRC20
status:
type: string
example: success
from:
type: string
example: THG9nncwASg3ub5rvVquocAHwwQbnKZxpH
to:
type: string
example: TPUjdnMrS7XDUFp5W6zgh4QDCW34nXa2x1
contract_address:
type: string
example: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t
token_id:
type: string
example: null
amount:
type: string
example: '2832.001791'
url:
type: string
example: 'https://api.chaingateway.io/receiver/webhooks/tron'
used_credits:
type: string
example: '1.154359'
logs:
type: array
example:
- 'Successfully sent TRX for bandwidth to THG9nncwASg3ub5rvVquocAHwwQbnKZxpH: e7205c6b64e3fb10262d5e235e4b08ba8ac22df5f0b39bf4be572f2263d19ed4'
- 'Energy purchased successfully'
- 'enough Resources: false'
- 'timeout reached: false'
- 'callback response: 200'
- 'enough Resources: true'
- 'callback response: 200'
items:
type: string
created_at:
type: string
example: '2024-09-11T13:30:48.000000Z'
updated_at:
type: string
example: '2024-09-11T13:31:26.000000Z'
tags:
- 'Tron Paymaster'
parameters:
-
in: path
name: id
description: 'The ID of the paymaster.'
example: architecto
required: true
schema:
type: string
/api/v2/tron/paymaster/estimate:
post:
summary: 'Estimate Paymaster Fees'
operationId: estimatePaymasterFees
description: "This endpoint is used to estimate the fees for a paymaster request.\n\nWith the creation of a paymaster request you need to pay for the energy and bandwidth that is needed to process the transaction.\nTo simplify the process of calculating the fees, we provide this endpoint to estimate the fees for a transaction.\nThe ressouces wich a transaction needs to be procesed are energy and bandwidth. Bandwidth is needed to send the transaction to the network and energy is needed to execute the transaction.\n\nTherefore it differs between the transaction types and the smart contracts how much energy and bandwidth is needed.\n\nAfter setteling yor paymaster request the fees will be deducted from your credit balance. If you don't have enough funds on your balance, the request will fail."
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Successfully estimated the fees'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully estimated the fees'
data:
energy_consumption: 32000
bandwidth_consumption: 368
paymaster_fee: 0.15
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully estimated the fees'
data:
type: object
properties:
energy_consumption:
type: integer
example: 32000
bandwidth_consumption:
type: integer
example: 368
paymaster_fee:
type: number
example: 0.15
tags:
- 'Tron Paymaster'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: 'The type of transaction.'
example: TRC20
enum:
- TRX
- TRC10
- TRC20
- TRC721
from:
type: string
description: 'The address to send the transaction from.'
example: TLkkCeNdJKPNUwucdro84WjswkzM62LCTH
to:
type: string
description: 'The address to send the transaction to.'
example: TUwmZghA7u2GxGxKaxM1mkCmsTF4wHs4vp
contractaddress:
type: string
description: 'The contract address of the token. This field is required when type is TRC20 or TRC721.'
example: 0x708c419d1b9ae123047f70787a503b6ba51e048a27966e0220cc5feXXXXXXXXX
tokenid:
type: number
description: 'The token id of the token. This field is required when type is TRC721 or TRC10.'
example: 1.0
amount:
type: string
description: 'The amount to send.'
example: '1'
password:
type: string
description: 'The password for the address. This field is required when privatekey is not present.'
example: your_password
privatekey:
type: string
description: 'The private key of the sender.'
example: 708c419d1b9ae123047f70787a503b6ba51e048a27966e0220cc5feXXXXXXXXX
callback_url:
type: string
description: 'The callback url to send the response to.'
example: 'https://example.com/callback'
required:
- type
- from
- to
- amount
/api/v2/tron/transactions/trc20/build:
post:
summary: 'Build TRC20 transaction (self signing)'
operationId: buildTRC20TransactionselfSigning
description: "This method creates a new TRC20 transaction for self signing, so this method will return the raw transaction hex.
\nUsing this method, the transaction will not be broadcasted to the blockchain.
"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created transaction'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully built transaction'
data:
result:
result: true
transaction:
visible: false
txID: a5d6cbdfb3845312887ce9cf22967be9ebae30b0fa4ff74ce86adc9805a1e31a
raw_data:
contract:
-
parameter:
value:
data: a9059cbb0000000000000000000000007a368be0e33278d1a688c290a61bf4c33474ec5600000000000000000000000000000000000000000000000000000000003567e0
owner_address: 41ea6787eaf73447b41f08c7d3e2957cf7de583b94
contract_address: 41ea51342dabbb928ae1e576bd39eff8aaf070a8c6
type_url: type.googleapis.com/protocol.TriggerSmartContract
type: TriggerSmartContract
ref_block_bytes: 3b77
ref_block_hash: f3e7eb650cc4ca62
expiration: 1742192007000
fee_limit: 15000000000
timestamp: 1742191950387
raw_data_hex: 0a023b772208f3e7eb650cc4ca6240d8aef195da325aae01081f12a9010a31747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e54726967676572536d617274436f6e747261637412740a1541ea6787eaf73447b41f08c7d3e2957cf7de583b94121541ea51342dabbb928ae1e576bd39eff8aaf070a8c62244a9059cbb0000000000000000000000007a368be0e33278d1a688c290a61bf4c33474ec5600000000000000000000000000000000000000000000000000000000003567e070b3f4ed95da32900180acc7f037
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully built transaction'
data:
type: object
properties:
result:
type: object
properties:
result:
type: boolean
example: true
transaction:
type: object
properties:
visible:
type: boolean
example: false
txID:
type: string
example: a5d6cbdfb3845312887ce9cf22967be9ebae30b0fa4ff74ce86adc9805a1e31a
raw_data:
type: object
properties:
contract:
type: array
example:
-
parameter:
value: { data: a9059cbb0000000000000000000000007a368be0e33278d1a688c290a61bf4c33474ec5600000000000000000000000000000000000000000000000000000000003567e0, owner_address: 41ea6787eaf73447b41f08c7d3e2957cf7de583b94, contract_address: 41ea51342dabbb928ae1e576bd39eff8aaf070a8c6 }
type_url: type.googleapis.com/protocol.TriggerSmartContract
type: TriggerSmartContract
items:
type: object
properties:
parameter:
type: object
properties: { value: { type: object, properties: { data: { type: string, example: a9059cbb0000000000000000000000007a368be0e33278d1a688c290a61bf4c33474ec5600000000000000000000000000000000000000000000000000000000003567e0 }, owner_address: { type: string, example: 41ea6787eaf73447b41f08c7d3e2957cf7de583b94 }, contract_address: { type: string, example: 41ea51342dabbb928ae1e576bd39eff8aaf070a8c6 } } }, type_url: { type: string, example: type.googleapis.com/protocol.TriggerSmartContract } }
type:
type: string
example: TriggerSmartContract
ref_block_bytes:
type: string
example: 3b77
ref_block_hash:
type: string
example: f3e7eb650cc4ca62
expiration:
type: integer
example: 1742192007000
fee_limit:
type: integer
example: 15000000000
timestamp:
type: integer
example: 1742191950387
raw_data_hex:
type: string
example: 0a023b772208f3e7eb650cc4ca6240d8aef195da325aae01081f12a9010a31747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e54726967676572536d617274436f6e747261637412740a1541ea6787eaf73447b41f08c7d3e2957cf7de583b94121541ea51342dabbb928ae1e576bd39eff8aaf070a8c62244a9059cbb0000000000000000000000007a368be0e33278d1a688c290a61bf4c33474ec5600000000000000000000000000000000000000000000000000000000003567e070b3f4ed95da32900180acc7f037
tags:
- 'Tron Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from.'
example: TLkkCeNdJKPNUwucdro84WjswkzM62LCTH
to:
type: string
description: 'The address to send the transaction to.'
example: TUwmZghA7u2GxGxKaxM1mkCmsTF4wHs4vp
contractaddress:
type: string
description: 'The contract address of the token.'
example: 0x708c419d1b9ae123047f70787a503b6ba51e048a27966e0220cc5feXXXXXXXXX
amount:
type: number
description: 'The amount to send.'
example: 1.0
required:
- from
- to
- contractaddress
- amount
/api/v2/tron/transactions/build:
post:
summary: 'Build TRX transaction (self signing)'
operationId: buildTRXTransactionselfSigning
description: "This method creates a new TRC20 transaction for self signing, so this method will return the raw transaction hex.
\nUsing this method, the transaction will not be broadcasted to the blockchain.
\n\nYou should use this method for self signing transactions.
\n\nTo send the transaction to the blockchain, you can use the broadcast endpoint.
"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created transaction'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created transaction'
data:
visible: true
txID: b1e0eaa2b4ea985338d6684b796d458ad2c762633ad7b9d8b003542ab067530f
raw_data:
contract:
-
parameter:
value:
amount: 3500000
owner_address: TM7QnQtPGAyMGokd3KjKdTpKjFUgTHW7pP
to_address: TXLd9QHrGF4Kvm4eng1hCcCFoqUGQKBH43
type_url: type.googleapis.com/protocol.TransferContract
type: TransferContract
ref_block_bytes: 3a8f
ref_block_hash: 4989085e2c13dd74
expiration: 1742191278000
timestamp: 1742191220631
raw_data_hex: 0a023a8f22084989085e2c13dd7440b0efc495da325a68080112640a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412330a15417a368be0e33278d1a688c290a61bf4c33474ec56121541ea6787eaf73447b41f08c7d3e2957cf7de583b9418e0cfd5017097afc195da32
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created transaction'
data:
type: object
properties:
visible:
type: boolean
example: true
txID:
type: string
example: b1e0eaa2b4ea985338d6684b796d458ad2c762633ad7b9d8b003542ab067530f
raw_data:
type: object
properties:
contract:
type: array
example:
-
parameter:
value:
amount: 3500000
owner_address: TM7QnQtPGAyMGokd3KjKdTpKjFUgTHW7pP
to_address: TXLd9QHrGF4Kvm4eng1hCcCFoqUGQKBH43
type_url: type.googleapis.com/protocol.TransferContract
type: TransferContract
items:
type: object
properties:
parameter:
type: object
properties:
value:
type: object
properties: { amount: { type: integer, example: 3500000 }, owner_address: { type: string, example: TM7QnQtPGAyMGokd3KjKdTpKjFUgTHW7pP }, to_address: { type: string, example: TXLd9QHrGF4Kvm4eng1hCcCFoqUGQKBH43 } }
type_url:
type: string
example: type.googleapis.com/protocol.TransferContract
type:
type: string
example: TransferContract
ref_block_bytes:
type: string
example: 3a8f
ref_block_hash:
type: string
example: 4989085e2c13dd74
expiration:
type: integer
example: 1742191278000
timestamp:
type: integer
example: 1742191220631
raw_data_hex:
type: string
example: 0a023a8f22084989085e2c13dd7440b0efc495da325a68080112640a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412330a15417a368be0e33278d1a688c290a61bf4c33474ec56121541ea6787eaf73447b41f08c7d3e2957cf7de583b9418e0cfd5017097afc195da32
tags:
- 'Tron Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
amount:
type: number
description: 'The amount to send.'
example: 1.0
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^T[a-zA-Z0-9]{33}$/.'
example: TUwmZghA7u2GxGxKaxM1mkCmsTF4wHs4vp
from:
type: string
description: 'The address to send the transaction from. Must match the regex /^T[a-zA-Z0-9]{33}$/.'
example: TLkkCeNdJKPNUwucdro84WjswkzM62LCTH
required:
- amount
- to
- from
/api/v2/tron/webhooks:
get:
summary: 'Get all webhooks'
operationId: getAllWebhooks
description: 'Lists all webhooks created by the user.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Tron Webhooks'
post:
summary: 'Create webhook'
operationId: createWebhook
description: 'Creates a new webhook for real-time communication and event notification.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Webhook created'
data:
webhook: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook created'
data:
type: object
properties:
webhook:
type: string
example: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
status: 422
ok: false
message: 'Data validation failed'
errors:
from:
- 'The from field format is invalid.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
from:
type: array
example:
- 'The from field format is invalid.'
items:
type: string
tags:
- 'Tron Webhooks'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The sender Tron address'
example: TWrTTVizHkF3LxTiWE9vCnhWC7CBpNXe22
to:
type: string
description: 'The receiver Tron address'
example: TWrTTVizHkF3LxTiWE9vCnhWC7CBpNXe22
url:
type: string
description: 'URL for webhook notifications (required). Must be a valid URL.'
example: 'http://vonrueden.com/'
contractaddress:
type: string
description: ''
example: TWrTTVizHkF3LxTiWE9vCnhWC7CBpNXe22
token_id:
type: string
description: 'This field is required when none of from and to are present.'
example: null
type:
type: string
description: ''
example: TRC20
enum:
- TRX
- TRC10
- TRC20
- TRC721
reference:
type: string
description: 'A reference for the webhook. Must not be greater than 255 characters.'
example: 'n'
nullable: true
required:
- url
'/api/v2/tron/webhooks/{id}':
get:
summary: 'Get webhook'
operationId: getWebhook
description: 'Show the details of a Webhook'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Tron Webhooks'
put:
summary: 'Update webhook'
operationId: updateWebhook
description: 'Updates an existing webhook with the provided data.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Webhook updated'
data:
id: 9b73d6ee-8a8b-44c3-b2c6-0bd1e1d8cd9a
from: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
to: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
contractaddress: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
type: BEP20
token_id: null
url: 'http://blanda.com/debitis-et-id-nisi-qui-id.html'
is_active: true
is_invalid: false
old_id: null
created_at: '2024-02-29T14:51:35.000000Z'
updated_at: '2024-02-29T14:52:33.000000Z'
deleted_at: null
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook updated'
data:
type: object
properties:
id:
type: string
example: 9b73d6ee-8a8b-44c3-b2c6-0bd1e1d8cd9a
from:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
to:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
contractaddress:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
type:
type: string
example: BEP20
token_id:
type: string
example: null
url:
type: string
example: 'http://blanda.com/debitis-et-id-nisi-qui-id.html'
is_active:
type: boolean
example: true
is_invalid:
type: boolean
example: false
old_id:
type: string
example: null
created_at:
type: string
example: '2024-02-29T14:51:35.000000Z'
updated_at:
type: string
example: '2024-02-29T14:52:33.000000Z'
deleted_at:
type: string
example: null
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: 404
ok: false
message: 'Webhook not found'
data: []
properties:
status:
type: integer
example: 404
ok:
type: boolean
example: false
message:
type: string
example: 'Webhook not found'
data:
type: array
example: []
tags:
- 'Tron Webhooks'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The sender Tron address'
example: TWrTTVizHkF3LxTiWE9vCnhWC7CBpNXe22
to:
type: string
description: 'The receiver Tron address'
example: TWrTTVizHkF3LxTiWE9vCnhWC7CBpNXe22
url:
type: string
description: 'URL for webhook notifications (required). Must be a valid URL.'
example: 'http://vonrueden.com/'
contractaddress:
type: string
description: ''
example: TWrTTVizHkF3LxTiWE9vCnhWC7CBpNXe22
token_id:
type: string
description: 'This field is required when none of from and to are present.'
example: null
type:
type: string
description: ''
example: TRC20
enum:
- TRX
- TRC10
- TRC20
- TRC721
reference:
type: string
description: 'A reference for the webhook. Must not be greater than 255 characters.'
example: 'n'
nullable: true
required:
- url
delete:
summary: 'Delete webhook'
operationId: deleteWebhook
description: 'This method will delete the specified webhook.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Webhook deleted'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook deleted'
data:
type: array
example: []
tags:
- 'Tron Webhooks'
parameters:
-
in: path
name: id
description: 'The UUID of the webhook you want to show.'
example: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
required: true
schema:
type: string
/api/v2/tron/webhooks/notifications:
get:
summary: 'Display all Webhook Notifications'
operationId: displayAllWebhookNotifications
description: 'Lists all webhook notifications created by the user for the specific Blockchain and Network'
parameters:
-
in: query
name: page
description: 'The page number to fetch'
example: 16
required: false
schema:
type: integer
description: 'The page number to fetch'
example: 16
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully fetched notifications'
current_page: 1
data:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
from: 1
last_page: 1
last_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications'
per_page: 15
prev_page_url: null
to: 1
total: 1
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully fetched notifications'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
items:
type: object
properties:
id:
type: string
example: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id:
type: string
example: 9ba897da-7651-4df6-80ef-11c898b195e5
txid:
type: string
example: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type:
type: string
example: TRC20
contractaddress:
type: string
example: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from:
type: string
example: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to:
type: string
example: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid:
type: string
example: null
amount:
type: string
example: null
blocknumber:
type: string
example: '19499380'
status:
type: string
example: failed
url:
type: string
example: 'https://example.com'
success:
type: boolean
example: false
attempts:
type: integer
example: 0
created_at:
type: string
example: '2024-05-05T19:33:52.000000Z'
updated_at:
type: string
example: '2024-05-05T19:33:54.000000Z'
network:
type: string
example: testnet
blockchain:
type: string
example: tron
response:
type: string
example: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications'
per_page:
type: integer
example: 15
prev_page_url:
type: string
example: null
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'Tron Webhooks'
/api/v2/tron/webhooks/notifications/failed:
get:
summary: 'Display all failed Webhook Notification'
operationId: displayAllFailedWebhookNotification
description: "Lists all failed webhook notifications created by the user for the specific Blockchain and Network\nBased on the response you can use our /webhooks/notifications/{id}/retry to retry every failed webhook.\n\nAfter you started the retry process, the webhook will be removed from this list. should the retry process fail, the webhook will be added back to this list."
parameters:
-
in: query
name: page
description: 'The page number to fetch'
example: 16
required: false
schema:
type: integer
description: 'The page number to fetch'
example: 16
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully fetched failed notifications'
current_page: 1
data:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
from: 1
last_page: 1
last_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed'
per_page: 15
prev_page_url: null
to: 1
total: 1
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully fetched failed notifications'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
items:
type: object
properties:
id:
type: string
example: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id:
type: string
example: 9ba897da-7651-4df6-80ef-11c898b195e5
txid:
type: string
example: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type:
type: string
example: TRC20
contractaddress:
type: string
example: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from:
type: string
example: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to:
type: string
example: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid:
type: string
example: null
amount:
type: string
example: null
blocknumber:
type: string
example: '19499380'
status:
type: string
example: failed
url:
type: string
example: 'https://example.com'
success:
type: boolean
example: false
attempts:
type: integer
example: 0
created_at:
type: string
example: '2024-05-05T19:33:52.000000Z'
updated_at:
type: string
example: '2024-05-05T19:33:54.000000Z'
network:
type: string
example: testnet
blockchain:
type: string
example: tron
response:
type: string
example: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed'
per_page:
type: integer
example: 15
prev_page_url:
type: string
example: null
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'Tron Webhooks'
'/api/v2/tron/webhooks/notifications/{id}/retry':
post:
summary: 'Retry a failed Webhook Notification'
operationId: retryAFailedWebhookNotification
description: 'Retries a failed webhook notification'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses: { }
tags:
- 'Tron Webhooks'
parameters:
-
in: path
name: id
description: 'The ID of the notification.'
example: architecto
required: true
schema:
type: string
/api/v2/ethereum/blocks/number:
get:
summary: 'Get latest block number'
operationId: getLatestBlockNumber
description: 'This Method returns the latest block number'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Latest block number fetched'
type: object
example:
status: 200
ok: true
message: 'Latest block number fetched'
data:
blocknumber: 123456
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Latest block number fetched'
data:
type: object
properties:
blocknumber:
type: integer
example: 123456
-
description: ''
type: object
example:
status: 200
ok: true
message: 'Latest block number fetched'
data: 19151363
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Latest block number fetched'
data:
type: integer
example: 19151363
tags:
- 'Ethereum Blockchain Queries'
'/api/v2/ethereum/blocks/{block_number}':
get:
summary: 'Get block by number or hash'
operationId: getBlockByNumberOrHash
description: 'This Method returns the block by its number'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Block fetched'
type: object
example:
status: 200
ok: true
message: 'Block fetched'
data:
difficulty: 16
extraData: '0xd482020a83626f7286676f312e3137856c696e75780000000000000000000000fb14f09854175ad6379c2fce286a474ba103fe8270c97ab4ce4a89949c00c54a1b38740f620ab9b66e0991804d4adc2c85baba80efc3a802aec73d8f2a2bd88600'
gasLimit: 20836455
gasUsed: '0xdc0281'
hash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
logsBloom: '0x0b759230fd529cda05e9663e8cd2f1a5c4b9b92cece1108b0a7391043fa15d44f89f59a86c6674183a5392d0a35d6405d1f48edb3a4aa428a01ac5ed02eea24d1415580c028451b5d871ca4b9ea14db59c32c64a25d43d0781137d5ea23dae24540ee29fa305a28818a8125b06c08d7c0944c460958d4e09bce2497003cf53b21121ffc2cc8922cb54953f0839834f2c968367b94a369bf8d22beccf40a03216facc84a11687df580810e0e2219871a97253a0231b262010009ca148390c11759b10064ffece08511de701bca853adf6dc60c049d4a9a01a00f9fe8fa302e385415248ff66840241e094908201a181048f1420a92ac90e41080c4fa10918599c'
miner: '0x0000000000000000000000000000000000000000'
mixHash: '0x0000000000000000000000000000000000000000000000000000000000000000'
nonce: '0x0000000000000000'
number: 21785493
parentHash: '0x8cacb1ad30d3623f3ed01eb4a6b8990de88a50a4c9c3380ee0f3bb63cfd290ce'
receiptsRoot: '0x8507f82a9c3fe4dc02d8ca6bd332c06db723cd9f3148bf65ed81b5ab2533db11'
sha3Uncles: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347'
size: 60687
stateRoot: '0x1e428a1eacaec62d26c2e410d76baf66ae7f598f3cee8eda5c0e94656576426f'
timestamp: '2021-11-25 13:19:46'
totalDifficulty: 261320853
transactions:
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0xe898563caf3b8ed945bd23e9f1a5eca1f395180e'
gas: '0x203c76'
gasPrice: '0x53d1ac1000'
hash: '0xd664519ee6a2bab1031da8e56f814d9626878de9aedef2426a5356d572280f97'
input: '0x38ed1739000000000000000000000000000000000000000000000000193e8f3326c4db0000000000000000000000000000000000000000000000000000b9a333dce606c800000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000e898563caf3b8ed945bd23e9f1a5eca1f395180e00000000000000000000000000000000000000000000000000000000619f915700000000000000000000000000000000000000000000000000000000000000020000000000000000000000002c89bbc92bd86f8075d1decc58c7f4e0107f286b0000000000000000000000007ceb23fd6bc0add59e62ac25578270cff1b9f619'
nonce: '0x168ac'
to: '0x1b02da8cb0d097eb8d57a175b88c7d8b47997506'
transactionIndex: '0x0'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x136'
r: '0xa1ac2567f13ba553713d4f21db8eb3617c04d51d7ed81964516aac8142528f52'
s: '0x11ac82d2353d6441f6bf1e182fbfae73b315461d1283f8048098311aac699b6f'
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0x41bf9148a378a12f0bf5d0ae050f2b72fd8fc290'
gas: '0x9aeb'
gasPrice: '0x14f46b0400'
hash: '0x65c649006ca5b5812d27b141b7620c884bdcf0b55872e2c879ce7e119bb92e40'
input: '0x2e1a7d4d00000000000000000000000000000000000000000000000d8d726b7177a80000'
nonce: '0xd'
to: '0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270'
transactionIndex: '0xe'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x135'
r: '0xac00b4880ad2d11d8443aca6e2b097e491fb5fe48466de30d12655b882d3b85f'
s: '0x377d1b9bb9bfbc3d565f34910240bd2cb81791dcf2016d07e595f1ada2c7ce15'
-
- '... More transactions here'
transactionsRoot: '0xdbab0c76f6a233225148be047c007572ffd7bd49b08d4da30c0a32fb5ae1ae02'
uncles: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Block fetched'
data:
type: object
properties:
difficulty:
type: integer
example: 16
extraData:
type: string
example: '0xd482020a83626f7286676f312e3137856c696e75780000000000000000000000fb14f09854175ad6379c2fce286a474ba103fe8270c97ab4ce4a89949c00c54a1b38740f620ab9b66e0991804d4adc2c85baba80efc3a802aec73d8f2a2bd88600'
gasLimit:
type: integer
example: 20836455
gasUsed:
type: string
example: '0xdc0281'
hash:
type: string
example: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
logsBloom:
type: string
example: '0x0b759230fd529cda05e9663e8cd2f1a5c4b9b92cece1108b0a7391043fa15d44f89f59a86c6674183a5392d0a35d6405d1f48edb3a4aa428a01ac5ed02eea24d1415580c028451b5d871ca4b9ea14db59c32c64a25d43d0781137d5ea23dae24540ee29fa305a28818a8125b06c08d7c0944c460958d4e09bce2497003cf53b21121ffc2cc8922cb54953f0839834f2c968367b94a369bf8d22beccf40a03216facc84a11687df580810e0e2219871a97253a0231b262010009ca148390c11759b10064ffece08511de701bca853adf6dc60c049d4a9a01a00f9fe8fa302e385415248ff66840241e094908201a181048f1420a92ac90e41080c4fa10918599c'
miner:
type: string
example: '0x0000000000000000000000000000000000000000'
mixHash:
type: string
example: '0x0000000000000000000000000000000000000000000000000000000000000000'
nonce:
type: string
example: '0x0000000000000000'
number:
type: integer
example: 21785493
parentHash:
type: string
example: '0x8cacb1ad30d3623f3ed01eb4a6b8990de88a50a4c9c3380ee0f3bb63cfd290ce'
receiptsRoot:
type: string
example: '0x8507f82a9c3fe4dc02d8ca6bd332c06db723cd9f3148bf65ed81b5ab2533db11'
sha3Uncles:
type: string
example: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347'
size:
type: integer
example: 60687
stateRoot:
type: string
example: '0x1e428a1eacaec62d26c2e410d76baf66ae7f598f3cee8eda5c0e94656576426f'
timestamp:
type: string
example: '2021-11-25 13:19:46'
totalDifficulty:
type: integer
example: 261320853
transactions:
type: array
example:
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0xe898563caf3b8ed945bd23e9f1a5eca1f395180e'
gas: '0x203c76'
gasPrice: '0x53d1ac1000'
hash: '0xd664519ee6a2bab1031da8e56f814d9626878de9aedef2426a5356d572280f97'
input: '0x38ed1739000000000000000000000000000000000000000000000000193e8f3326c4db0000000000000000000000000000000000000000000000000000b9a333dce606c800000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000e898563caf3b8ed945bd23e9f1a5eca1f395180e00000000000000000000000000000000000000000000000000000000619f915700000000000000000000000000000000000000000000000000000000000000020000000000000000000000002c89bbc92bd86f8075d1decc58c7f4e0107f286b0000000000000000000000007ceb23fd6bc0add59e62ac25578270cff1b9f619'
nonce: '0x168ac'
to: '0x1b02da8cb0d097eb8d57a175b88c7d8b47997506'
transactionIndex: '0x0'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x136'
r: '0xa1ac2567f13ba553713d4f21db8eb3617c04d51d7ed81964516aac8142528f52'
s: '0x11ac82d2353d6441f6bf1e182fbfae73b315461d1283f8048098311aac699b6f'
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0x41bf9148a378a12f0bf5d0ae050f2b72fd8fc290'
gas: '0x9aeb'
gasPrice: '0x14f46b0400'
hash: '0x65c649006ca5b5812d27b141b7620c884bdcf0b55872e2c879ce7e119bb92e40'
input: '0x2e1a7d4d00000000000000000000000000000000000000000000000d8d726b7177a80000'
nonce: '0xd'
to: '0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270'
transactionIndex: '0xe'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x135'
r: '0xac00b4880ad2d11d8443aca6e2b097e491fb5fe48466de30d12655b882d3b85f'
s: '0x377d1b9bb9bfbc3d565f34910240bd2cb81791dcf2016d07e595f1ada2c7ce15'
-
- '... More transactions here'
items:
type: object
properties:
blockHash:
type: string
example: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber:
type: string
example: '0x14c6b95'
from:
type: string
example: '0xe898563caf3b8ed945bd23e9f1a5eca1f395180e'
gas:
type: string
example: '0x203c76'
gasPrice:
type: string
example: '0x53d1ac1000'
hash:
type: string
example: '0xd664519ee6a2bab1031da8e56f814d9626878de9aedef2426a5356d572280f97'
input:
type: string
example: '0x38ed1739000000000000000000000000000000000000000000000000193e8f3326c4db0000000000000000000000000000000000000000000000000000b9a333dce606c800000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000e898563caf3b8ed945bd23e9f1a5eca1f395180e00000000000000000000000000000000000000000000000000000000619f915700000000000000000000000000000000000000000000000000000000000000020000000000000000000000002c89bbc92bd86f8075d1decc58c7f4e0107f286b0000000000000000000000007ceb23fd6bc0add59e62ac25578270cff1b9f619'
nonce:
type: string
example: '0x168ac'
to:
type: string
example: '0x1b02da8cb0d097eb8d57a175b88c7d8b47997506'
transactionIndex:
type: string
example: '0x0'
value:
type: string
example: '0x0'
type:
type: string
example: '0x0'
chainId:
type: string
example: '0x89'
v:
type: string
example: '0x136'
r:
type: string
example: '0xa1ac2567f13ba553713d4f21db8eb3617c04d51d7ed81964516aac8142528f52'
s:
type: string
example: '0x11ac82d2353d6441f6bf1e182fbfae73b315461d1283f8048098311aac699b6f'
transactionsRoot:
type: string
example: '0xdbab0c76f6a233225148be047c007572ffd7bd49b08d4da30c0a32fb5ae1ae02'
uncles:
type: array
example: []
-
description: ''
type: object
nullable: true
tags:
- 'Ethereum Blockchain Queries'
parameters:
-
in: path
name: block_number
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '19151363'
/api/v2/ethereum/transactions:
get:
summary: 'List Transactions'
operationId: listTransactions
description: "This method lists your transaction history. It lists all transactions including ERC20 and ERC721 transactions.
\n Please note that we dont index your addresses. We list only transactions that were made with the Chaingateway API"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Paginated result'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transactions'
current_page: 1
data:
-
id: 1
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.001000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T09:00:18.000000Z'
updated_at: '2024-02-13T09:00:18.000000Z'
-
id: 4
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0x5da4f33531fab8ecfe6f36a1300265f772b5f11c2da736a39b0b4b0c1b97c3e2'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.384200000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:01:26.000000Z'
updated_at: '2024-02-13T10:01:26.000000Z'
-
id: 5
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x1b7ecf53527e9a9ec09c448b2f594357e8a09f52c02c96d0de33fe435750d371'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:34:34.000000Z'
updated_at: '2024-02-13T10:34:34.000000Z'
-
id: 6
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x5b293a7289e8405fb8402f0bfa6e7464fdc9bfbc11aaa7874d4a7216b4079729'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:35:57.000000Z'
updated_at: '2024-02-13T10:35:57.000000Z'
-
id: 7
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x8830bd8d0cf0dfeac6d4cc345888ae52f9ca8b3a3cf37859919786bd9cd8ae2f'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '100.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:22:03.000000Z'
updated_at: '2024-02-13T12:22:03.000000Z'
-
id: 8
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:36:48.000000Z'
updated_at: '2024-02-13T12:36:48.000000Z'
first_page_url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
from: 1
last_page: 1
last_page_url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions'
per_page: 50
prev_page_url: null
to: 6
total: 6
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transactions'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 1
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.001000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T09:00:18.000000Z'
updated_at: '2024-02-13T09:00:18.000000Z'
-
id: 4
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0x5da4f33531fab8ecfe6f36a1300265f772b5f11c2da736a39b0b4b0c1b97c3e2'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.384200000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:01:26.000000Z'
updated_at: '2024-02-13T10:01:26.000000Z'
-
id: 5
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x1b7ecf53527e9a9ec09c448b2f594357e8a09f52c02c96d0de33fe435750d371'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:34:34.000000Z'
updated_at: '2024-02-13T10:34:34.000000Z'
-
id: 6
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x5b293a7289e8405fb8402f0bfa6e7464fdc9bfbc11aaa7874d4a7216b4079729'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:35:57.000000Z'
updated_at: '2024-02-13T10:35:57.000000Z'
-
id: 7
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x8830bd8d0cf0dfeac6d4cc345888ae52f9ca8b3a3cf37859919786bd9cd8ae2f'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '100.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:22:03.000000Z'
updated_at: '2024-02-13T12:22:03.000000Z'
-
id: 8
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:36:48.000000Z'
updated_at: '2024-02-13T12:36:48.000000Z'
items:
type: object
properties:
id:
type: integer
example: 1
user_id:
type: integer
example: 1
blockchain:
type: string
example: bsc
network:
type: string
example: testnet
type:
type: string
example: default
txid:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from:
type: string
example: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to:
type: string
example: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress:
type: string
example: null
amount:
type: string
example: '0.001000000000'
tokenid:
type: string
example: null
responseJson:
type: string
example: null
httpStatus:
type: string
example: null
created_at:
type: string
example: '2024-02-13T09:00:18.000000Z'
updated_at:
type: string
example: '2024-02-13T09:00:18.000000Z'
first_page_url:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions'
per_page:
type: integer
example: 50
prev_page_url:
type: string
example: null
to:
type: integer
example: 6
total:
type: integer
example: 6
tags:
- 'Ethereum Transactions'
post:
summary: 'Create transaction'
operationId: createTransaction
description: 'This method creates a new transaction.
'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created'
data:
adderess: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created'
data:
type: object
properties:
adderess:
type: string
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
401:
description: 'Wrong password'
content:
application/json:
schema:
type: object
example:
status: 401
ok: false
message: 'Wrong password provided'
errors: []
properties:
status:
type: integer
example: 401
ok:
type: boolean
example: false
message:
type: string
example: 'Wrong password provided'
errors:
type: array
example: []
422:
description: 'Insufficent funds'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors:
type: array
example: []
tags:
- 'Ethereum Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
amount:
type: string
description: 'The amount to send.'
example: '1000000000000000000'
gas:
type: integer
description: 'The gas limit for the transaction.'
example: 21000
gasprice:
type: number
description: 'The gas price for the transaction.'
example: 1000000000.0
maxPriorityFeePerGas:
type: number
description: 'The maximum priority fee per gas for the transaction.'
example: 1000000000.0
maxFeePerGas:
type: number
description: 'The maximum fee per gas for the transaction.'
example: 1000000000.0
password:
type: string
description: 'The password for the wallet. This field is required when privatekey is not present.'
example: password
privatekey:
type: string
description: ''
example: architecto
data:
type: string
description: 'The data for the transaction.'
example: 0x
nonce:
type: string
description: 'The nonce for the transaction.'
example: '0'
required:
- from
- to
- amount
parameters:
-
in: path
name: page
description: 'Optional parameter. The page number'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '1'
'/api/v2/ethereum/transactions/{txid}':
get:
summary: 'Get transaction'
operationId: getTransaction
description: 'This method shows a transaction'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: Decoded
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction'
data:
transaction:
blockHash: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber: '37701506'
from: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gas: '21000'
gasPrice: '3.0000000000'
hash: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
nonce: '14'
to: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionIndex: '8'
maxFeePerGas: null
maxPriorityFeePerGas: null
amount: '0.001000000000000000'
contractaddress: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
type: ETH
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction'
data:
type: object
properties:
transaction:
type: object
properties:
blockHash:
type: string
example: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber:
type: string
example: '37701506'
from:
type: string
example: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gas:
type: string
example: '21000'
gasPrice:
type: string
example: '3.0000000000'
hash:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
nonce:
type: string
example: '14'
to:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionIndex:
type: string
example: '8'
maxFeePerGas:
type: string
example: null
maxPriorityFeePerGas:
type: string
example: null
amount:
type: string
example: '0.001000000000000000'
contractaddress:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
type:
type: string
example: ETH
422:
description: 'Transaction not found'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'transaction not found'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'transaction not found'
errors:
type: array
example: []
tags:
- 'Ethereum Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
-
in: path
name: decoded
description: "Optional parameter. If set to 'decoded' it will return the decoded transaction"
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: decoded
'/api/v2/ethereum/transactions/{txid}/decoded':
get:
summary: 'Get decoded transaction'
operationId: getDecodedTransaction
description: 'This method will decode the transaction and shows you human readable data of the transaction'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Transaction not found'
type: object
example:
status: 422
ok: false
message: 'transaction not found'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'transaction not found'
errors:
type: array
example: []
-
description: 'Transaction fetched'
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction'
data:
blockHash: '0x00bb7d10d61156c1972c8f817ac6bf408b8495a6484492f95ebad57f89fed581'
blockNumber: '67604928'
from: '0x899abf76af40336006df10b71680b925aa86b6f7'
gas: '93835'
gasPrice: '136.9438649750'
maxFeePerGas: '141.3817174220'
maxPriorityFeePerGas: '25.0000000000'
hash: '0x4409ddadf59391177b72ac005e88c3a334887f11ef552356e16477a13a671dd8'
input: '0x954093c40000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000003643aa6479e5a06fc30000000000000000000000000000000000000000000000000000000067a49a2c'
nonce: '174853'
to: '0xbce8b135053c6b9665c09c23d1ef422c48d00ab4'
transactionIndex: '122'
amount: '0'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction'
data:
type: object
properties:
blockHash:
type: string
example: '0x00bb7d10d61156c1972c8f817ac6bf408b8495a6484492f95ebad57f89fed581'
blockNumber:
type: string
example: '67604928'
from:
type: string
example: '0x899abf76af40336006df10b71680b925aa86b6f7'
gas:
type: string
example: '93835'
gasPrice:
type: string
example: '136.9438649750'
maxFeePerGas:
type: string
example: '141.3817174220'
maxPriorityFeePerGas:
type: string
example: '25.0000000000'
hash:
type: string
example: '0x4409ddadf59391177b72ac005e88c3a334887f11ef552356e16477a13a671dd8'
input:
type: string
example: '0x954093c40000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000003643aa6479e5a06fc30000000000000000000000000000000000000000000000000000000067a49a2c'
nonce:
type: string
example: '174853'
to:
type: string
example: '0xbce8b135053c6b9665c09c23d1ef422c48d00ab4'
transactionIndex:
type: string
example: '122'
amount:
type: string
example: '0'
tags:
- 'Ethereum Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
-
in: path
name: decoded
description: "Optional parameter. If set to 'decoded' it will return the decoded transaction"
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: decoded
/api/v2/ethereum/addresses:
post:
summary: 'Create Address'
operationId: createAddress
description: "Creates a new address wich can be used to send and receive crypto currencies, ERC20 and ERC721 tokens.\nplease provide a stron password within the request body. You will need the password everytime you interact with your address.\n\nThere are two ways to create an Address:\n- unsecure: You will directly get the private key of your address which can be used to create transactions\n- secure: You define a password, the privatekley will use this password as well as our own encryption chain to store the privatekey on our database. You can use this password instead of a private key to create transactions\n\n\n"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Address created'
data:
adderess: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Address created'
data:
type: object
properties:
adderess:
type: string
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
-
description: ''
type: object
example:
status: 422
ok: false
message: 'Your address limit exceeded. Please upgrade your plan'
data: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Your address limit exceeded. Please upgrade your plan'
data:
type: array
example: []
tags:
- 'Ethereum Addresses'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
get:
summary: 'List addresses'
operationId: listAddresses
description: 'Lists all addresses you have created but not yet deleted'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Ethereum Addresses'
'/api/v2/ethereum/addresses/{address}':
delete:
summary: 'Delete Address'
operationId: deleteAddress
description: 'This method will delete your address. This decreases your used address metrics'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Address deleted'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Address deleted'
data:
type: array
example: []
tags:
- 'Ethereum Addresses'
post:
summary: 'Update Address Password'
operationId: updateAddressPassword
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Password updated'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Password updated'
data:
type: array
example: []
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- 'Ethereum Addresses'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
old_password:
type: string
description: 'The old password of the user.'
example: old_password123
new_password:
type: string
description: 'The new password of the user.'
example: new_password123
required:
- old_password
- new_password
parameters:
-
in: path
name: address
description: 'The address you want to delete.'
example: '0xd280406b68901ae4F2431d1830dF5232F49C19fA'
required: true
schema:
type: string
'/api/v2/ethereum/balances/{address}':
get:
summary: 'Get balance of an address'
operationId: getBalanceOfAnAddress
description: 'Get the balance of an address'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Balance fetched'
data: '0.000000000000000000'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Balance fetched'
data:
type: string
example: '0.000000000000000000'
tags:
- 'Ethereum Blockchain Queries'
parameters:
-
in: path
name: address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0x2214C41B139d8752bf8Bf17BDfee5B6EA4E3157B'
'/api/v2/ethereum/balances/{address}/erc20/{contract_address}':
get:
summary: 'Get balance of an ERC20 token'
operationId: getBalanceOfAnERC20Token
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
200:
description: ''
content:
application/json:
schema:
type: string
example: '{ "status": 200, "ok": true, "message": "ERC20 balance fetched", "data": "0.000000" }'
tags:
- 'Ethereum Blockchain Queries'
parameters:
-
in: path
name: address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0x2214C41B139d8752bf8Bf17BDfee5B6EA4E3157B'
-
in: path
name: contract_address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0x388C818CA8B9251b393131C08a736A67ccB19297'
'/api/v2/ethereum/addresses/export/{address}':
post:
summary: ''
operationId: postApiV2EthereumAddressesExportAddress
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Private key exported'
data:
private_key: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Private key exported'
data:
type: object
properties:
private_key:
type: string
example: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- 'Ethereum Addresses'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
parameters:
-
in: path
name: address
description: ''
example: architecto
required: true
schema:
type: string
/api/v2/ethereum/addresses/import:
post:
summary: 'Import Private Key'
operationId: importPrivateKey
description: 'Import a Private key to use the secure wallet functionality for transactions.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Address imported successfully'
data: []
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Address imported successfully'
data:
type: array
example: []
tags:
- 'Ethereum Addresses'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
address:
type: string
description: ''
example: architecto
privatekey:
type: string
description: ''
example: architecto
password:
type: string
description: ''
example: architecto
required:
- address
- privatekey
- password
/api/v2/ethereum/transactions/erc20:
post:
summary: 'Create ERC20 transaction'
operationId: createERC20Transaction
description: 'This method creates a new ERC20 transaction.
'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created'
data:
adderess: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created'
data:
type: object
properties:
adderess:
type: string
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
401:
description: 'Wrong password'
content:
application/json:
schema:
type: object
example:
status: 401
ok: false
message: 'Wrong password provided'
errors: []
properties:
status:
type: integer
example: 401
ok:
type: boolean
example: false
message:
type: string
example: 'Wrong password provided'
errors:
type: array
example: []
422:
description: 'Insufficent funds'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors:
type: array
example: []
tags:
- 'Ethereum Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
contractaddress:
type: string
description: 'The address of the ERC20 contract. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
gas:
type: integer
description: 'The gas limit for the transaction.'
example: 21000
gasprice:
type: number
description: 'The gas price for the transaction.'
example: 1000000000.0
maxPriorityFeePerGas:
type: number
description: 'The maximum priority fee per gas for the transaction.'
example: 1000000000.0
maxFeePerGas:
type: number
description: 'The maximum fee per gas for the transaction.'
example: 1000000000.0
password:
type: string
description: 'The password to unlock the wallet if you working with a password protected wallet created with chaingateway. . This field is required when privatekey is not present.'
example: password123
privatekey:
type: string
description: 'The private key to sign the transaction, only needed if working with non-secure chaingateway wallet.'
example: '0x123456'
nonce:
type: string
description: 'The nonce for the transaction.'
example: '0x123456'
amount:
type: number
description: 'The amount of the ERC20 token to send.'
example: 100.0
required:
- from
- contractaddress
- to
- amount
/api/v2/ethereum/transactions/erc721:
post:
summary: 'Create ERC721 transaction'
operationId: createERC721Transaction
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created'
data:
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created'
data:
type: object
properties:
txid:
type: string
example: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
401:
description: 'Wrong password'
content:
application/json:
schema:
type: object
example:
status: 401
ok: false
message: 'Wrong password provided'
errors: []
properties:
status:
type: integer
example: 401
ok:
type: boolean
example: false
message:
type: string
example: 'Wrong password provided'
errors:
type: array
example: []
422:
description: 'Insufficent funds'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors:
type: array
example: []
tags:
- 'Ethereum Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
contractaddress:
type: string
description: 'The address of the ERC721 contract. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
tokenId:
type: integer
description: 'The token ID to send.'
example: 1
gas:
type: integer
description: 'The gas limit for the transaction.'
example: 21000
gasprice:
type: number
description: 'The gas price for the transaction.'
example: 1000000000.0
maxPriorityFeePerGas:
type: number
description: ''
example: 4326.41688
maxFeePerGas:
type: number
description: ''
example: 4326.41688
password:
type: string
description: 'This field is required when privatekey is not present.'
example: '|]|{+-'
privatekey:
type: string
description: ''
example: architecto
data:
type: string
description: ''
example: architecto
nonce:
type: string
description: ''
example: architecto
required:
- from
- contractaddress
- to
- tokenId
'/api/v2/ethereum/erc20/{contract_address}':
get:
summary: 'Get ERC20 contract information'
operationId: getERC20ContractInformation
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'ERC20 contract fetched'
type: object
example:
status: 200
ok: true
message: 'ERC20 contract fetched'
data:
contractaddress: '0xdAC17F958D2ee523a2206206994597C13D831ec7'
decimals: 6
totalSupply: '51998658367.642960'
name: TetherUSD
symbol: USDT
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'ERC20 contract fetched'
data:
type: object
properties:
contractaddress:
type: string
example: '0xdAC17F958D2ee523a2206206994597C13D831ec7'
decimals:
type: integer
example: 6
totalSupply:
type: string
example: '51998658367.642960'
name:
type: string
example: TetherUSD
symbol:
type: string
example: USDT
-
description: ''
type: object
example:
status: success
data: data
properties:
status:
type: string
example: success
data:
type: string
example: data
tags:
- 'Ethereum Blockchain Queries'
parameters:
-
in: path
name: contract_address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0x388C818CA8B9251b393131C08a736A67ccB19297'
'/api/v2/ethereum/transactions/{txid}/receipt/{decoded}':
get:
summary: 'Get receipt'
operationId: getReceipt
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: Decoded
type: object
example:
status: 200
ok: true
message: 'Succesfully parsedtransaction receipt'
data:
transaction:
blockHash: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber: '37701506'
cumulativeGasUsed: '627702'
effectiveGasPrice: '3.0000000000'
from: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed: '21000'
logs: []
logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status: true
to: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex: '8'
type: '8'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsedtransaction receipt'
data:
type: object
properties:
transaction:
type: object
properties:
blockHash:
type: string
example: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber:
type: string
example: '37701506'
cumulativeGasUsed:
type: string
example: '627702'
effectiveGasPrice:
type: string
example: '3.0000000000'
from:
type: string
example: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed:
type: string
example: '21000'
logs:
type: array
example: []
logsBloom:
type: string
example: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status:
type: boolean
example: true
to:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex:
type: string
example: '8'
type:
type: string
example: '8'
-
description: Encoded
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction receipt'
data:
transaction:
blockHash: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber: '0x23f4782'
contractAddress: null
cumulativeGasUsed: '0x993f6'
effectiveGasPrice: '0xb2d05e00'
from: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed: '0x5208'
logs: []
logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status: '0x1'
to: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex: '0x8'
type: '0x0'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction receipt'
data:
type: object
properties:
transaction:
type: object
properties:
blockHash:
type: string
example: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber:
type: string
example: '0x23f4782'
contractAddress:
type: string
example: null
cumulativeGasUsed:
type: string
example: '0x993f6'
effectiveGasPrice:
type: string
example: '0xb2d05e00'
from:
type: string
example: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed:
type: string
example: '0x5208'
logs:
type: array
example: []
logsBloom:
type: string
example: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status:
type: string
example: '0x1'
to:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex:
type: string
example: '0x8'
type:
type: string
example: '0x0'
422:
description: 'Transaction receipt not found'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'transaction not found'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'transaction not found'
errors:
type: array
example: []
tags:
- 'Ethereum Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
-
in: path
name: decoded
description: "Optional parameter. If set to 'decoded' it will return the decoded transaction"
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: decoded
'/api/v2/ethereum/addresses/export/{address}/privatekey':
post:
summary: ''
operationId: postApiV2EthereumAddressesExportAddressPrivatekey
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Private key exported'
data:
private_key: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Private key exported'
data:
type: object
properties:
private_key:
type: string
example: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- 'Ethereum Addresses'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
parameters:
-
in: path
name: address
description: ''
example: architecto
required: true
schema:
type: string
/api/v2/ethereum/gasprice:
get:
summary: 'Get Gas Price'
operationId: getGasPrice
description: 'This Method returns the gas price'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Gas price fetched'
content:
application/json:
schema:
type: object
example:
ok: true
status: 200
message: 'Successfully parsed'
data:
gasPrice: '12.28'
properties:
ok:
type: boolean
example: true
status:
type: integer
example: 200
message:
type: string
example: 'Successfully parsed'
data:
type: object
properties:
gasPrice:
type: string
example: '12.28'
tags:
- 'Ethereum Blockchain Queries'
'/api/v2/ethereum/nfts/{contract_address}/owner/{token_id}':
get:
summary: 'Get NFT Owner'
operationId: getNFTOwner
description: 'This Method returns the owner of an NFT'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'ERC721 owner fetched'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'ERC721 owner fetched'
data:
owner: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'ERC721 owner fetched'
data:
type: object
properties:
owner:
type: string
example: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
422:
description: 'Error! Could not get NFT owner'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Error! Could not get NFT owner'
error: 'Error message here'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Error! Could not get NFT owner'
error:
type: string
example: 'Error message here'
tags:
- 'Ethereum Blockchain Queries'
parameters:
-
in: path
name: contract_address
description: 'The contract address'
example: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
required: true
schema:
type: string
-
in: path
name: token_id
description: 'The token id'
example: '1234'
required: true
schema:
type: string
'/api/v2/ethereum/nfts/{contract_address}/uri/{token_id}':
get:
summary: 'Get NFT Token URI'
operationId: getNFTTokenURI
description: 'This Method returns the URI of an NFT token'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'NFT token URI fetched'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'NFT token URI fetched'
data:
tokenURI: 'https://api.opensea.io/api/v1/metadata/0x06012c8cf97bead5deae237070f9587f8e7a266d/1'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'NFT token URI fetched'
data:
type: object
properties:
tokenURI:
type: string
example: 'https://api.opensea.io/api/v1/metadata/0x06012c8cf97bead5deae237070f9587f8e7a266d/1'
422:
description: 'Error! Could not get NFT token URI'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Error! Could not get NFT token URI'
error: 'Error message here'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Error! Could not get NFT token URI'
error:
type: string
example: 'Error message here'
tags:
- 'Ethereum Blockchain Queries'
parameters:
-
in: path
name: contract_address
description: 'The contract address'
example: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
required: true
schema:
type: string
-
in: path
name: token_id
description: 'The token id'
example: '1234'
required: true
schema:
type: string
'/api/v2/ethereum/balances/{address}/erc20':
get:
summary: 'Display all the token balances of a wallet'
operationId: displayAllTheTokenBalancesOfAWallet
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Ethereum Blockchain Queries'
parameters:
-
in: path
name: address
description: ''
example: architecto
required: true
schema:
type: string
/api/v2/ethereum/webhooks:
get:
summary: 'Get all webhooks'
operationId: getAllWebhooks
description: 'Lists all webhooks created by the user.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Ethereum Webhooks'
post:
summary: 'Create webhook'
operationId: createWebhook
description: 'Creates a new webhook for real-time communication and event notification.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Webhook created'
data:
webhook: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook created'
data:
type: object
properties:
webhook:
type: string
example: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
status: 422
ok: false
message: 'Data validation failed'
errors:
from:
- 'The from field format is invalid.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
from:
type: array
example:
- 'The from field format is invalid.'
items:
type: string
tags:
- 'Ethereum Webhooks'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'Sender address (required if not "to"). This field is required when to is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
to:
type: string
description: 'Receiver address (required if not providing "from"). This field is required when from is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
url:
type: string
description: 'URL for webhook notifications (required). Must be a valid URL.'
example: 'http://vonrueden.com/'
contractaddress:
type: string
description: 'The Address of an Contract you want to track (Not allowwed on Bitcoin). This field is required when none of from and to are present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
token_id:
type: string
description: 'This field is required when none of from and to are present.'
example: null
type:
type: string
description: ''
example: ERC20
enum:
- ETH
- ERC20
- ERC721
reference:
type: string
description: 'A reference for the webhook. Must not be greater than 255 characters.'
example: 'n'
nullable: true
required:
- url
'/api/v2/ethereum/webhooks/{id}':
get:
summary: 'Get webhook'
operationId: getWebhook
description: 'Show the details of a Webhook'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Ethereum Webhooks'
put:
summary: 'Update webhook'
operationId: updateWebhook
description: 'Updates an existing webhook with the provided data.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Webhook updated'
data:
id: 9b73d6ee-8a8b-44c3-b2c6-0bd1e1d8cd9a
from: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
to: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
contractaddress: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
type: BEP20
token_id: null
url: 'http://blanda.com/debitis-et-id-nisi-qui-id.html'
is_active: true
is_invalid: false
old_id: null
created_at: '2024-02-29T14:51:35.000000Z'
updated_at: '2024-02-29T14:52:33.000000Z'
deleted_at: null
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook updated'
data:
type: object
properties:
id:
type: string
example: 9b73d6ee-8a8b-44c3-b2c6-0bd1e1d8cd9a
from:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
to:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
contractaddress:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
type:
type: string
example: BEP20
token_id:
type: string
example: null
url:
type: string
example: 'http://blanda.com/debitis-et-id-nisi-qui-id.html'
is_active:
type: boolean
example: true
is_invalid:
type: boolean
example: false
old_id:
type: string
example: null
created_at:
type: string
example: '2024-02-29T14:51:35.000000Z'
updated_at:
type: string
example: '2024-02-29T14:52:33.000000Z'
deleted_at:
type: string
example: null
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: 404
ok: false
message: 'Webhook not found'
data: []
properties:
status:
type: integer
example: 404
ok:
type: boolean
example: false
message:
type: string
example: 'Webhook not found'
data:
type: array
example: []
tags:
- 'Ethereum Webhooks'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'Sender address (required if not "to"). This field is required when to is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
to:
type: string
description: 'Receiver address (required if not providing "from"). This field is required when from is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
url:
type: string
description: 'URL for webhook notifications (required). Must be a valid URL.'
example: 'http://vonrueden.com/'
contractaddress:
type: string
description: 'The Address of an Contract you want to track (Not allowwed on Bitcoin). This field is required when none of from and to are present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
token_id:
type: string
description: 'This field is required when none of from and to are present.'
example: null
type:
type: string
description: ''
example: ERC20
enum:
- ETH
- ERC20
- ERC721
reference:
type: string
description: 'A reference for the webhook. Must not be greater than 255 characters.'
example: 'n'
nullable: true
required:
- url
delete:
summary: 'Delete webhook'
operationId: deleteWebhook
description: 'This method will delete the specified webhook.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Webhook deleted'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook deleted'
data:
type: array
example: []
tags:
- 'Ethereum Webhooks'
parameters:
-
in: path
name: id
description: 'The UUID of the webhook you want to show.'
example: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
required: true
schema:
type: string
/api/v2/ethereum/webhooks/notifications:
get:
summary: 'Display all Webhook Notifications'
operationId: displayAllWebhookNotifications
description: 'Lists all webhook notifications created by the user for the specific Blockchain and Network'
parameters:
-
in: query
name: page
description: 'The page number to fetch'
example: 16
required: false
schema:
type: integer
description: 'The page number to fetch'
example: 16
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully fetched notifications'
current_page: 1
data:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
from: 1
last_page: 1
last_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications'
per_page: 15
prev_page_url: null
to: 1
total: 1
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully fetched notifications'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
items:
type: object
properties:
id:
type: string
example: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id:
type: string
example: 9ba897da-7651-4df6-80ef-11c898b195e5
txid:
type: string
example: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type:
type: string
example: TRC20
contractaddress:
type: string
example: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from:
type: string
example: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to:
type: string
example: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid:
type: string
example: null
amount:
type: string
example: null
blocknumber:
type: string
example: '19499380'
status:
type: string
example: failed
url:
type: string
example: 'https://example.com'
success:
type: boolean
example: false
attempts:
type: integer
example: 0
created_at:
type: string
example: '2024-05-05T19:33:52.000000Z'
updated_at:
type: string
example: '2024-05-05T19:33:54.000000Z'
network:
type: string
example: testnet
blockchain:
type: string
example: tron
response:
type: string
example: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications'
per_page:
type: integer
example: 15
prev_page_url:
type: string
example: null
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'Ethereum Webhooks'
/api/v2/ethereum/webhooks/notifications/failed:
get:
summary: 'Display all failed Webhook Notification'
operationId: displayAllFailedWebhookNotification
description: "Lists all failed webhook notifications created by the user for the specific Blockchain and Network\nBased on the response you can use our /webhooks/notifications/{id}/retry to retry every failed webhook.\n\nAfter you started the retry process, the webhook will be removed from this list. should the retry process fail, the webhook will be added back to this list."
parameters:
-
in: query
name: page
description: 'The page number to fetch'
example: 16
required: false
schema:
type: integer
description: 'The page number to fetch'
example: 16
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully fetched failed notifications'
current_page: 1
data:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
from: 1
last_page: 1
last_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed'
per_page: 15
prev_page_url: null
to: 1
total: 1
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully fetched failed notifications'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
items:
type: object
properties:
id:
type: string
example: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id:
type: string
example: 9ba897da-7651-4df6-80ef-11c898b195e5
txid:
type: string
example: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type:
type: string
example: TRC20
contractaddress:
type: string
example: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from:
type: string
example: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to:
type: string
example: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid:
type: string
example: null
amount:
type: string
example: null
blocknumber:
type: string
example: '19499380'
status:
type: string
example: failed
url:
type: string
example: 'https://example.com'
success:
type: boolean
example: false
attempts:
type: integer
example: 0
created_at:
type: string
example: '2024-05-05T19:33:52.000000Z'
updated_at:
type: string
example: '2024-05-05T19:33:54.000000Z'
network:
type: string
example: testnet
blockchain:
type: string
example: tron
response:
type: string
example: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed'
per_page:
type: integer
example: 15
prev_page_url:
type: string
example: null
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'Ethereum Webhooks'
'/api/v2/ethereum/webhooks/notifications/{id}/retry':
post:
summary: 'Retry a failed Webhook Notification'
operationId: retryAFailedWebhookNotification
description: 'Retries a failed webhook notification'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses: { }
tags:
- 'Ethereum Webhooks'
parameters:
-
in: path
name: id
description: 'The ID of the notification.'
example: architecto
required: true
schema:
type: string
'/api/v2/polygon/balances/{address}/erc20':
get:
summary: 'Display all the token balances of a wallet'
operationId: displayAllTheTokenBalancesOfAWallet
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Ethereum Blockchain Queries'
parameters:
-
in: path
name: address
description: ''
example: architecto
required: true
schema:
type: string
/api/v2/bsc/blocks/number:
get:
summary: 'Get latest block number'
operationId: getLatestBlockNumber
description: 'This Method returns the latest block number'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Latest block number fetched'
type: object
example:
status: 200
ok: true
message: 'Latest block number fetched'
data:
blocknumber: 123456
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Latest block number fetched'
data:
type: object
properties:
blocknumber:
type: integer
example: 123456
-
description: ''
type: object
example:
status: 200
ok: true
message: 'Latest block number fetched'
data: 19151363
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Latest block number fetched'
data:
type: integer
example: 19151363
tags:
- 'BSC Blockchain Queries'
'/api/v2/bsc/blocks/{block_number}':
get:
summary: 'Get block by number or hash'
operationId: getBlockByNumberOrHash
description: 'This Method returns the block by its number'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Block fetched'
type: object
example:
status: 200
ok: true
message: 'Block fetched'
data:
difficulty: 16
extraData: '0xd482020a83626f7286676f312e3137856c696e75780000000000000000000000fb14f09854175ad6379c2fce286a474ba103fe8270c97ab4ce4a89949c00c54a1b38740f620ab9b66e0991804d4adc2c85baba80efc3a802aec73d8f2a2bd88600'
gasLimit: 20836455
gasUsed: '0xdc0281'
hash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
logsBloom: '0x0b759230fd529cda05e9663e8cd2f1a5c4b9b92cece1108b0a7391043fa15d44f89f59a86c6674183a5392d0a35d6405d1f48edb3a4aa428a01ac5ed02eea24d1415580c028451b5d871ca4b9ea14db59c32c64a25d43d0781137d5ea23dae24540ee29fa305a28818a8125b06c08d7c0944c460958d4e09bce2497003cf53b21121ffc2cc8922cb54953f0839834f2c968367b94a369bf8d22beccf40a03216facc84a11687df580810e0e2219871a97253a0231b262010009ca148390c11759b10064ffece08511de701bca853adf6dc60c049d4a9a01a00f9fe8fa302e385415248ff66840241e094908201a181048f1420a92ac90e41080c4fa10918599c'
miner: '0x0000000000000000000000000000000000000000'
mixHash: '0x0000000000000000000000000000000000000000000000000000000000000000'
nonce: '0x0000000000000000'
number: 21785493
parentHash: '0x8cacb1ad30d3623f3ed01eb4a6b8990de88a50a4c9c3380ee0f3bb63cfd290ce'
receiptsRoot: '0x8507f82a9c3fe4dc02d8ca6bd332c06db723cd9f3148bf65ed81b5ab2533db11'
sha3Uncles: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347'
size: 60687
stateRoot: '0x1e428a1eacaec62d26c2e410d76baf66ae7f598f3cee8eda5c0e94656576426f'
timestamp: '2021-11-25 13:19:46'
totalDifficulty: 261320853
transactions:
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0xe898563caf3b8ed945bd23e9f1a5eca1f395180e'
gas: '0x203c76'
gasPrice: '0x53d1ac1000'
hash: '0xd664519ee6a2bab1031da8e56f814d9626878de9aedef2426a5356d572280f97'
input: '0x38ed1739000000000000000000000000000000000000000000000000193e8f3326c4db0000000000000000000000000000000000000000000000000000b9a333dce606c800000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000e898563caf3b8ed945bd23e9f1a5eca1f395180e00000000000000000000000000000000000000000000000000000000619f915700000000000000000000000000000000000000000000000000000000000000020000000000000000000000002c89bbc92bd86f8075d1decc58c7f4e0107f286b0000000000000000000000007ceb23fd6bc0add59e62ac25578270cff1b9f619'
nonce: '0x168ac'
to: '0x1b02da8cb0d097eb8d57a175b88c7d8b47997506'
transactionIndex: '0x0'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x136'
r: '0xa1ac2567f13ba553713d4f21db8eb3617c04d51d7ed81964516aac8142528f52'
s: '0x11ac82d2353d6441f6bf1e182fbfae73b315461d1283f8048098311aac699b6f'
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0x41bf9148a378a12f0bf5d0ae050f2b72fd8fc290'
gas: '0x9aeb'
gasPrice: '0x14f46b0400'
hash: '0x65c649006ca5b5812d27b141b7620c884bdcf0b55872e2c879ce7e119bb92e40'
input: '0x2e1a7d4d00000000000000000000000000000000000000000000000d8d726b7177a80000'
nonce: '0xd'
to: '0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270'
transactionIndex: '0xe'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x135'
r: '0xac00b4880ad2d11d8443aca6e2b097e491fb5fe48466de30d12655b882d3b85f'
s: '0x377d1b9bb9bfbc3d565f34910240bd2cb81791dcf2016d07e595f1ada2c7ce15'
-
- '... More transactions here'
transactionsRoot: '0xdbab0c76f6a233225148be047c007572ffd7bd49b08d4da30c0a32fb5ae1ae02'
uncles: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Block fetched'
data:
type: object
properties:
difficulty:
type: integer
example: 16
extraData:
type: string
example: '0xd482020a83626f7286676f312e3137856c696e75780000000000000000000000fb14f09854175ad6379c2fce286a474ba103fe8270c97ab4ce4a89949c00c54a1b38740f620ab9b66e0991804d4adc2c85baba80efc3a802aec73d8f2a2bd88600'
gasLimit:
type: integer
example: 20836455
gasUsed:
type: string
example: '0xdc0281'
hash:
type: string
example: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
logsBloom:
type: string
example: '0x0b759230fd529cda05e9663e8cd2f1a5c4b9b92cece1108b0a7391043fa15d44f89f59a86c6674183a5392d0a35d6405d1f48edb3a4aa428a01ac5ed02eea24d1415580c028451b5d871ca4b9ea14db59c32c64a25d43d0781137d5ea23dae24540ee29fa305a28818a8125b06c08d7c0944c460958d4e09bce2497003cf53b21121ffc2cc8922cb54953f0839834f2c968367b94a369bf8d22beccf40a03216facc84a11687df580810e0e2219871a97253a0231b262010009ca148390c11759b10064ffece08511de701bca853adf6dc60c049d4a9a01a00f9fe8fa302e385415248ff66840241e094908201a181048f1420a92ac90e41080c4fa10918599c'
miner:
type: string
example: '0x0000000000000000000000000000000000000000'
mixHash:
type: string
example: '0x0000000000000000000000000000000000000000000000000000000000000000'
nonce:
type: string
example: '0x0000000000000000'
number:
type: integer
example: 21785493
parentHash:
type: string
example: '0x8cacb1ad30d3623f3ed01eb4a6b8990de88a50a4c9c3380ee0f3bb63cfd290ce'
receiptsRoot:
type: string
example: '0x8507f82a9c3fe4dc02d8ca6bd332c06db723cd9f3148bf65ed81b5ab2533db11'
sha3Uncles:
type: string
example: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347'
size:
type: integer
example: 60687
stateRoot:
type: string
example: '0x1e428a1eacaec62d26c2e410d76baf66ae7f598f3cee8eda5c0e94656576426f'
timestamp:
type: string
example: '2021-11-25 13:19:46'
totalDifficulty:
type: integer
example: 261320853
transactions:
type: array
example:
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0xe898563caf3b8ed945bd23e9f1a5eca1f395180e'
gas: '0x203c76'
gasPrice: '0x53d1ac1000'
hash: '0xd664519ee6a2bab1031da8e56f814d9626878de9aedef2426a5356d572280f97'
input: '0x38ed1739000000000000000000000000000000000000000000000000193e8f3326c4db0000000000000000000000000000000000000000000000000000b9a333dce606c800000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000e898563caf3b8ed945bd23e9f1a5eca1f395180e00000000000000000000000000000000000000000000000000000000619f915700000000000000000000000000000000000000000000000000000000000000020000000000000000000000002c89bbc92bd86f8075d1decc58c7f4e0107f286b0000000000000000000000007ceb23fd6bc0add59e62ac25578270cff1b9f619'
nonce: '0x168ac'
to: '0x1b02da8cb0d097eb8d57a175b88c7d8b47997506'
transactionIndex: '0x0'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x136'
r: '0xa1ac2567f13ba553713d4f21db8eb3617c04d51d7ed81964516aac8142528f52'
s: '0x11ac82d2353d6441f6bf1e182fbfae73b315461d1283f8048098311aac699b6f'
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0x41bf9148a378a12f0bf5d0ae050f2b72fd8fc290'
gas: '0x9aeb'
gasPrice: '0x14f46b0400'
hash: '0x65c649006ca5b5812d27b141b7620c884bdcf0b55872e2c879ce7e119bb92e40'
input: '0x2e1a7d4d00000000000000000000000000000000000000000000000d8d726b7177a80000'
nonce: '0xd'
to: '0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270'
transactionIndex: '0xe'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x135'
r: '0xac00b4880ad2d11d8443aca6e2b097e491fb5fe48466de30d12655b882d3b85f'
s: '0x377d1b9bb9bfbc3d565f34910240bd2cb81791dcf2016d07e595f1ada2c7ce15'
-
- '... More transactions here'
items:
type: object
properties:
blockHash:
type: string
example: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber:
type: string
example: '0x14c6b95'
from:
type: string
example: '0xe898563caf3b8ed945bd23e9f1a5eca1f395180e'
gas:
type: string
example: '0x203c76'
gasPrice:
type: string
example: '0x53d1ac1000'
hash:
type: string
example: '0xd664519ee6a2bab1031da8e56f814d9626878de9aedef2426a5356d572280f97'
input:
type: string
example: '0x38ed1739000000000000000000000000000000000000000000000000193e8f3326c4db0000000000000000000000000000000000000000000000000000b9a333dce606c800000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000e898563caf3b8ed945bd23e9f1a5eca1f395180e00000000000000000000000000000000000000000000000000000000619f915700000000000000000000000000000000000000000000000000000000000000020000000000000000000000002c89bbc92bd86f8075d1decc58c7f4e0107f286b0000000000000000000000007ceb23fd6bc0add59e62ac25578270cff1b9f619'
nonce:
type: string
example: '0x168ac'
to:
type: string
example: '0x1b02da8cb0d097eb8d57a175b88c7d8b47997506'
transactionIndex:
type: string
example: '0x0'
value:
type: string
example: '0x0'
type:
type: string
example: '0x0'
chainId:
type: string
example: '0x89'
v:
type: string
example: '0x136'
r:
type: string
example: '0xa1ac2567f13ba553713d4f21db8eb3617c04d51d7ed81964516aac8142528f52'
s:
type: string
example: '0x11ac82d2353d6441f6bf1e182fbfae73b315461d1283f8048098311aac699b6f'
transactionsRoot:
type: string
example: '0xdbab0c76f6a233225148be047c007572ffd7bd49b08d4da30c0a32fb5ae1ae02'
uncles:
type: array
example: []
-
description: ''
type: object
nullable: true
tags:
- 'BSC Blockchain Queries'
parameters:
-
in: path
name: block_number
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '19151363'
/api/v2/bsc/transactions:
get:
summary: 'List Transactions'
operationId: listTransactions
description: "This method lists your transaction history. It lists all transactions including ERC20 and ERC721 transactions.
\n Please note that we dont index your addresses. We list only transactions that were made with the Chaingateway API"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Paginated result'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transactions'
current_page: 1
data:
-
id: 1
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.001000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T09:00:18.000000Z'
updated_at: '2024-02-13T09:00:18.000000Z'
-
id: 4
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0x5da4f33531fab8ecfe6f36a1300265f772b5f11c2da736a39b0b4b0c1b97c3e2'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.384200000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:01:26.000000Z'
updated_at: '2024-02-13T10:01:26.000000Z'
-
id: 5
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x1b7ecf53527e9a9ec09c448b2f594357e8a09f52c02c96d0de33fe435750d371'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:34:34.000000Z'
updated_at: '2024-02-13T10:34:34.000000Z'
-
id: 6
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x5b293a7289e8405fb8402f0bfa6e7464fdc9bfbc11aaa7874d4a7216b4079729'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:35:57.000000Z'
updated_at: '2024-02-13T10:35:57.000000Z'
-
id: 7
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x8830bd8d0cf0dfeac6d4cc345888ae52f9ca8b3a3cf37859919786bd9cd8ae2f'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '100.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:22:03.000000Z'
updated_at: '2024-02-13T12:22:03.000000Z'
-
id: 8
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:36:48.000000Z'
updated_at: '2024-02-13T12:36:48.000000Z'
first_page_url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
from: 1
last_page: 1
last_page_url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions'
per_page: 50
prev_page_url: null
to: 6
total: 6
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transactions'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 1
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.001000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T09:00:18.000000Z'
updated_at: '2024-02-13T09:00:18.000000Z'
-
id: 4
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0x5da4f33531fab8ecfe6f36a1300265f772b5f11c2da736a39b0b4b0c1b97c3e2'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.384200000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:01:26.000000Z'
updated_at: '2024-02-13T10:01:26.000000Z'
-
id: 5
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x1b7ecf53527e9a9ec09c448b2f594357e8a09f52c02c96d0de33fe435750d371'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:34:34.000000Z'
updated_at: '2024-02-13T10:34:34.000000Z'
-
id: 6
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x5b293a7289e8405fb8402f0bfa6e7464fdc9bfbc11aaa7874d4a7216b4079729'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:35:57.000000Z'
updated_at: '2024-02-13T10:35:57.000000Z'
-
id: 7
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x8830bd8d0cf0dfeac6d4cc345888ae52f9ca8b3a3cf37859919786bd9cd8ae2f'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '100.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:22:03.000000Z'
updated_at: '2024-02-13T12:22:03.000000Z'
-
id: 8
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:36:48.000000Z'
updated_at: '2024-02-13T12:36:48.000000Z'
items:
type: object
properties:
id:
type: integer
example: 1
user_id:
type: integer
example: 1
blockchain:
type: string
example: bsc
network:
type: string
example: testnet
type:
type: string
example: default
txid:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from:
type: string
example: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to:
type: string
example: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress:
type: string
example: null
amount:
type: string
example: '0.001000000000'
tokenid:
type: string
example: null
responseJson:
type: string
example: null
httpStatus:
type: string
example: null
created_at:
type: string
example: '2024-02-13T09:00:18.000000Z'
updated_at:
type: string
example: '2024-02-13T09:00:18.000000Z'
first_page_url:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions'
per_page:
type: integer
example: 50
prev_page_url:
type: string
example: null
to:
type: integer
example: 6
total:
type: integer
example: 6
tags:
- 'BSC Transactions'
post:
summary: 'Create transaction'
operationId: createTransaction
description: 'This method creates a new transaction.
'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created'
data:
adderess: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created'
data:
type: object
properties:
adderess:
type: string
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
401:
description: 'Wrong password'
content:
application/json:
schema:
type: object
example:
status: 401
ok: false
message: 'Wrong password provided'
errors: []
properties:
status:
type: integer
example: 401
ok:
type: boolean
example: false
message:
type: string
example: 'Wrong password provided'
errors:
type: array
example: []
422:
description: 'Insufficent funds'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors:
type: array
example: []
tags:
- 'BSC Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
amount:
type: string
description: 'The amount to send.'
example: '1000000000000000000'
gas:
type: integer
description: 'The gas limit for the transaction.'
example: 21000
gasprice:
type: number
description: 'The gas price for the transaction.'
example: 1000000000.0
maxPriorityFeePerGas:
type: number
description: 'The maximum priority fee per gas for the transaction.'
example: 1000000000.0
maxFeePerGas:
type: number
description: 'The maximum fee per gas for the transaction.'
example: 1000000000.0
password:
type: string
description: 'The password for the wallet. This field is required when privatekey is not present.'
example: password
privatekey:
type: string
description: ''
example: architecto
data:
type: string
description: 'The data for the transaction.'
example: 0x
nonce:
type: string
description: 'The nonce for the transaction.'
example: '0'
required:
- from
- to
- amount
parameters:
-
in: path
name: page
description: 'Optional parameter. The page number'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '1'
'/api/v2/bsc/transactions/{txid}':
get:
summary: 'Get transaction'
operationId: getTransaction
description: 'This method shows a transaction'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: Decoded
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction'
data:
transaction:
blockHash: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber: '37701506'
from: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gas: '21000'
gasPrice: '3.0000000000'
hash: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
nonce: '14'
to: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionIndex: '8'
maxFeePerGas: null
maxPriorityFeePerGas: null
amount: '0.001000000000000000'
contractaddress: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
type: ETH
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction'
data:
type: object
properties:
transaction:
type: object
properties:
blockHash:
type: string
example: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber:
type: string
example: '37701506'
from:
type: string
example: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gas:
type: string
example: '21000'
gasPrice:
type: string
example: '3.0000000000'
hash:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
nonce:
type: string
example: '14'
to:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionIndex:
type: string
example: '8'
maxFeePerGas:
type: string
example: null
maxPriorityFeePerGas:
type: string
example: null
amount:
type: string
example: '0.001000000000000000'
contractaddress:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
type:
type: string
example: ETH
422:
description: 'Transaction not found'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'transaction not found'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'transaction not found'
errors:
type: array
example: []
tags:
- 'BSC Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
-
in: path
name: decoded
description: "Optional parameter. If set to 'decoded' it will return the decoded transaction"
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: decoded
'/api/v2/bsc/transactions/{txid}/decoded':
get:
summary: 'Get decoded transaction'
operationId: getDecodedTransaction
description: 'This method will decode the transaction and shows you human readable data of the transaction'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Transaction not found'
type: object
example:
status: 422
ok: false
message: 'transaction not found'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'transaction not found'
errors:
type: array
example: []
-
description: 'Transaction fetched'
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction'
data:
blockHash: '0x00bb7d10d61156c1972c8f817ac6bf408b8495a6484492f95ebad57f89fed581'
blockNumber: '67604928'
from: '0x899abf76af40336006df10b71680b925aa86b6f7'
gas: '93835'
gasPrice: '136.9438649750'
maxFeePerGas: '141.3817174220'
maxPriorityFeePerGas: '25.0000000000'
hash: '0x4409ddadf59391177b72ac005e88c3a334887f11ef552356e16477a13a671dd8'
input: '0x954093c40000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000003643aa6479e5a06fc30000000000000000000000000000000000000000000000000000000067a49a2c'
nonce: '174853'
to: '0xbce8b135053c6b9665c09c23d1ef422c48d00ab4'
transactionIndex: '122'
amount: '0'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction'
data:
type: object
properties:
blockHash:
type: string
example: '0x00bb7d10d61156c1972c8f817ac6bf408b8495a6484492f95ebad57f89fed581'
blockNumber:
type: string
example: '67604928'
from:
type: string
example: '0x899abf76af40336006df10b71680b925aa86b6f7'
gas:
type: string
example: '93835'
gasPrice:
type: string
example: '136.9438649750'
maxFeePerGas:
type: string
example: '141.3817174220'
maxPriorityFeePerGas:
type: string
example: '25.0000000000'
hash:
type: string
example: '0x4409ddadf59391177b72ac005e88c3a334887f11ef552356e16477a13a671dd8'
input:
type: string
example: '0x954093c40000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000003643aa6479e5a06fc30000000000000000000000000000000000000000000000000000000067a49a2c'
nonce:
type: string
example: '174853'
to:
type: string
example: '0xbce8b135053c6b9665c09c23d1ef422c48d00ab4'
transactionIndex:
type: string
example: '122'
amount:
type: string
example: '0'
tags:
- 'BSC Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
-
in: path
name: decoded
description: "Optional parameter. If set to 'decoded' it will return the decoded transaction"
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: decoded
/api/v2/bsc/addresses:
post:
summary: 'Create Address'
operationId: createAddress
description: "Creates a new address wich can be used to send and receive crypto currencies, ERC20 and ERC721 tokens.\nplease provide a stron password within the request body. You will need the password everytime you interact with your address.\n\nThere are two ways to create an Address:\n- unsecure: You will directly get the private key of your address which can be used to create transactions\n- secure: You define a password, the privatekley will use this password as well as our own encryption chain to store the privatekey on our database. You can use this password instead of a private key to create transactions\n\n\n"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Address created'
data:
adderess: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Address created'
data:
type: object
properties:
adderess:
type: string
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
-
description: ''
type: object
example:
status: 422
ok: false
message: 'Your address limit exceeded. Please upgrade your plan'
data: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Your address limit exceeded. Please upgrade your plan'
data:
type: array
example: []
tags:
- 'BSC Addresses'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
get:
summary: 'List addresses'
operationId: listAddresses
description: 'Lists all addresses you have created but not yet deleted'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'BSC Addresses'
'/api/v2/bsc/addresses/{address}':
delete:
summary: 'Delete Address'
operationId: deleteAddress
description: 'This method will delete your address. This decreases your used address metrics'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Address deleted'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Address deleted'
data:
type: array
example: []
tags:
- 'BSC Addresses'
post:
summary: 'Update Address Password'
operationId: updateAddressPassword
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Password updated'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Password updated'
data:
type: array
example: []
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- 'BSC Addresses'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
old_password:
type: string
description: 'The old password of the user.'
example: old_password123
new_password:
type: string
description: 'The new password of the user.'
example: new_password123
required:
- old_password
- new_password
parameters:
-
in: path
name: address
description: 'The address you want to delete.'
example: '0xd280406b68901ae4F2431d1830dF5232F49C19fA'
required: true
schema:
type: string
'/api/v2/bsc/balances/{address}':
get:
summary: 'Get balance of an address'
operationId: getBalanceOfAnAddress
description: 'Get the balance of an address'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Balance fetched'
data: '0.000000000000000000'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Balance fetched'
data:
type: string
example: '0.000000000000000000'
tags:
- 'BSC Blockchain Queries'
parameters:
-
in: path
name: address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0x0000000000000000000000000000000000001000'
'/api/v2/bsc/balances/{address}/bep20/{contract_address}':
get:
summary: 'Get balance of an BEP20 token'
operationId: getBalanceOfAnBEP20Token
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
200:
description: ''
content:
application/json:
schema:
type: string
example: '{ "status": 200, "ok": true, "message": "BEP20 balance fetched", "data": "0.000000" }'
tags:
- 'BSC Blockchain Queries'
parameters:
-
in: path
name: address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0xcd631BbBA7C83804e88121f6ad903073fFC5212c'
-
in: path
name: contract_address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0x8965349fb649A33a30cbFDa057D8eC2C48AbE2A2'
'/api/v2/bsc/addresses/export/{address}':
post:
summary: ''
operationId: postApiV2BscAddressesExportAddress
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Private key exported'
data:
private_key: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Private key exported'
data:
type: object
properties:
private_key:
type: string
example: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- 'BSC Addresses'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
parameters:
-
in: path
name: address
description: ''
example: architecto
required: true
schema:
type: string
/api/v2/bsc/addresses/import:
post:
summary: 'Import Private Key'
operationId: importPrivateKey
description: 'Import a Private key to use the secure wallet functionality for transactions.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Address imported successfully'
data: []
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Address imported successfully'
data:
type: array
example: []
tags:
- 'BSC Addresses'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
address:
type: string
description: ''
example: architecto
privatekey:
type: string
description: ''
example: architecto
password:
type: string
description: ''
example: architecto
required:
- address
- privatekey
- password
/api/v2/bsc/transactions/bep20:
post:
summary: 'Create ERC20 transaction'
operationId: createERC20Transaction
description: 'This method creates a new ERC20 transaction.
'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created'
data:
adderess: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created'
data:
type: object
properties:
adderess:
type: string
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
401:
description: 'Wrong password'
content:
application/json:
schema:
type: object
example:
status: 401
ok: false
message: 'Wrong password provided'
errors: []
properties:
status:
type: integer
example: 401
ok:
type: boolean
example: false
message:
type: string
example: 'Wrong password provided'
errors:
type: array
example: []
422:
description: 'Insufficent funds'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors:
type: array
example: []
tags:
- 'BSC Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
contractaddress:
type: string
description: 'The address of the ERC20 contract. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
gas:
type: integer
description: 'The gas limit for the transaction.'
example: 21000
gasprice:
type: number
description: 'The gas price for the transaction.'
example: 1000000000.0
maxPriorityFeePerGas:
type: number
description: 'The maximum priority fee per gas for the transaction.'
example: 1000000000.0
maxFeePerGas:
type: number
description: 'The maximum fee per gas for the transaction.'
example: 1000000000.0
password:
type: string
description: 'The password to unlock the wallet if you working with a password protected wallet created with chaingateway. . This field is required when privatekey is not present.'
example: password123
privatekey:
type: string
description: 'The private key to sign the transaction, only needed if working with non-secure chaingateway wallet.'
example: '0x123456'
nonce:
type: string
description: 'The nonce for the transaction.'
example: '0x123456'
amount:
type: number
description: 'The amount of the ERC20 token to send.'
example: 100.0
required:
- from
- contractaddress
- to
- amount
/api/v2/bsc/transactions/bep721:
post:
summary: 'Create ERC721 transaction'
operationId: createERC721Transaction
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created'
data:
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created'
data:
type: object
properties:
txid:
type: string
example: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
401:
description: 'Wrong password'
content:
application/json:
schema:
type: object
example:
status: 401
ok: false
message: 'Wrong password provided'
errors: []
properties:
status:
type: integer
example: 401
ok:
type: boolean
example: false
message:
type: string
example: 'Wrong password provided'
errors:
type: array
example: []
422:
description: 'Insufficent funds'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors:
type: array
example: []
tags:
- 'BSC Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
contractaddress:
type: string
description: 'The address of the ERC721 contract. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
tokenId:
type: integer
description: 'The token ID to send.'
example: 1
gas:
type: integer
description: 'The gas limit for the transaction.'
example: 21000
gasprice:
type: number
description: 'The gas price for the transaction.'
example: 1000000000.0
maxPriorityFeePerGas:
type: number
description: ''
example: 4326.41688
maxFeePerGas:
type: number
description: ''
example: 4326.41688
password:
type: string
description: 'This field is required when privatekey is not present.'
example: '|]|{+-'
privatekey:
type: string
description: ''
example: architecto
data:
type: string
description: ''
example: architecto
nonce:
type: string
description: ''
example: architecto
required:
- from
- contractaddress
- to
- tokenId
'/api/v2/bsc/bep20/{contract_address}':
get:
summary: 'Get BEP20 contract information'
operationId: getBEP20ContractInformation
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'ERC20 contract fetched'
type: object
example:
status: 200
ok: true
message: 'ERC20 contract fetched'
data:
contractaddress: '0xdAC17F958D2ee523a2206206994597C13D831ec7'
decimals: 6
totalSupply: '51998658367.642960'
name: TetherUSD
symbol: USDT
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'ERC20 contract fetched'
data:
type: object
properties:
contractaddress:
type: string
example: '0xdAC17F958D2ee523a2206206994597C13D831ec7'
decimals:
type: integer
example: 6
totalSupply:
type: string
example: '51998658367.642960'
name:
type: string
example: TetherUSD
symbol:
type: string
example: USDT
-
description: ''
type: object
example:
status: success
data: data
properties:
status:
type: string
example: success
data:
type: string
example: data
tags:
- 'BSC Blockchain Queries'
parameters:
-
in: path
name: contract_address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0x8965349fb649A33a30cbFDa057D8eC2C48AbE2A2'
'/api/v2/bsc/transactions/{txid}/receipt/{decoded}':
get:
summary: 'Get receipt'
operationId: getReceipt
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: Decoded
type: object
example:
status: 200
ok: true
message: 'Succesfully parsedtransaction receipt'
data:
transaction:
blockHash: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber: '37701506'
cumulativeGasUsed: '627702'
effectiveGasPrice: '3.0000000000'
from: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed: '21000'
logs: []
logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status: true
to: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex: '8'
type: '8'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsedtransaction receipt'
data:
type: object
properties:
transaction:
type: object
properties:
blockHash:
type: string
example: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber:
type: string
example: '37701506'
cumulativeGasUsed:
type: string
example: '627702'
effectiveGasPrice:
type: string
example: '3.0000000000'
from:
type: string
example: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed:
type: string
example: '21000'
logs:
type: array
example: []
logsBloom:
type: string
example: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status:
type: boolean
example: true
to:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex:
type: string
example: '8'
type:
type: string
example: '8'
-
description: Encoded
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction receipt'
data:
transaction:
blockHash: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber: '0x23f4782'
contractAddress: null
cumulativeGasUsed: '0x993f6'
effectiveGasPrice: '0xb2d05e00'
from: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed: '0x5208'
logs: []
logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status: '0x1'
to: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex: '0x8'
type: '0x0'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction receipt'
data:
type: object
properties:
transaction:
type: object
properties:
blockHash:
type: string
example: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber:
type: string
example: '0x23f4782'
contractAddress:
type: string
example: null
cumulativeGasUsed:
type: string
example: '0x993f6'
effectiveGasPrice:
type: string
example: '0xb2d05e00'
from:
type: string
example: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed:
type: string
example: '0x5208'
logs:
type: array
example: []
logsBloom:
type: string
example: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status:
type: string
example: '0x1'
to:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex:
type: string
example: '0x8'
type:
type: string
example: '0x0'
422:
description: 'Transaction receipt not found'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'transaction not found'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'transaction not found'
errors:
type: array
example: []
tags:
- 'BSC Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
-
in: path
name: decoded
description: "Optional parameter. If set to 'decoded' it will return the decoded transaction"
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: decoded
'/api/v2/bsc/addresses/export/{address}/privatekey':
post:
summary: ''
operationId: postApiV2BscAddressesExportAddressPrivatekey
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Private key exported'
data:
private_key: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Private key exported'
data:
type: object
properties:
private_key:
type: string
example: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- 'BSC Addresses'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
parameters:
-
in: path
name: address
description: ''
example: architecto
required: true
schema:
type: string
/api/v2/bsc/gasprice:
get:
summary: 'Get Gas Price'
operationId: getGasPrice
description: 'This Method returns the gas price'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Gas price fetched'
content:
application/json:
schema:
type: object
example:
ok: true
status: 200
message: 'Successfully parsed'
data:
gasPrice: '12.28'
properties:
ok:
type: boolean
example: true
status:
type: integer
example: 200
message:
type: string
example: 'Successfully parsed'
data:
type: object
properties:
gasPrice:
type: string
example: '12.28'
tags:
- 'BSC Blockchain Queries'
'/api/v2/bsc/nfts/{contract_address}/owner/{token_id}':
get:
summary: 'Get NFT Owner'
operationId: getNFTOwner
description: 'This Method returns the owner of an NFT'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'ERC721 owner fetched'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'ERC721 owner fetched'
data:
owner: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'ERC721 owner fetched'
data:
type: object
properties:
owner:
type: string
example: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
422:
description: 'Error! Could not get NFT owner'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Error! Could not get NFT owner'
error: 'Error message here'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Error! Could not get NFT owner'
error:
type: string
example: 'Error message here'
tags:
- 'BSC Blockchain Queries'
parameters:
-
in: path
name: contract_address
description: 'The contract address'
example: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
required: true
schema:
type: string
-
in: path
name: token_id
description: 'The token id'
example: '1234'
required: true
schema:
type: string
'/api/v2/bsc/nfts/{contract_address}/uri/{token_id}':
get:
summary: 'Get NFT Token URI'
operationId: getNFTTokenURI
description: 'This Method returns the URI of an NFT token'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'NFT token URI fetched'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'NFT token URI fetched'
data:
tokenURI: 'https://api.opensea.io/api/v1/metadata/0x06012c8cf97bead5deae237070f9587f8e7a266d/1'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'NFT token URI fetched'
data:
type: object
properties:
tokenURI:
type: string
example: 'https://api.opensea.io/api/v1/metadata/0x06012c8cf97bead5deae237070f9587f8e7a266d/1'
422:
description: 'Error! Could not get NFT token URI'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Error! Could not get NFT token URI'
error: 'Error message here'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Error! Could not get NFT token URI'
error:
type: string
example: 'Error message here'
tags:
- 'BSC Blockchain Queries'
parameters:
-
in: path
name: contract_address
description: 'The contract address'
example: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
required: true
schema:
type: string
-
in: path
name: token_id
description: 'The token id'
example: '1234'
required: true
schema:
type: string
'/api/v2/bsc/balances/{address}/bep20':
get:
summary: 'Display all the token balances of a wallet'
operationId: displayAllTheTokenBalancesOfAWallet
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'BSC Blockchain Queries'
parameters:
-
in: path
name: address
description: ''
example: architecto
required: true
schema:
type: string
/api/v2/bsc/webhooks:
get:
summary: 'Get all webhooks'
operationId: getAllWebhooks
description: 'Lists all webhooks created by the user.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'BSC Webhooks'
post:
summary: 'Create webhook'
operationId: createWebhook
description: 'Creates a new webhook for real-time communication and event notification.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Webhook created'
data:
webhook: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook created'
data:
type: object
properties:
webhook:
type: string
example: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
status: 422
ok: false
message: 'Data validation failed'
errors:
from:
- 'The from field format is invalid.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
from:
type: array
example:
- 'The from field format is invalid.'
items:
type: string
tags:
- 'BSC Webhooks'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'Sender address (required if not "to"). This field is required when to is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
to:
type: string
description: 'Receiver address (required if not providing "from"). This field is required when from is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
url:
type: string
description: 'URL for webhook notifications (required). Must be a valid URL.'
example: 'http://vonrueden.com/'
contractaddress:
type: string
description: 'The Address of an Contract you want to track (Not allowwed on Bitcoin). This field is required when none of from and to are present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
token_id:
type: string
description: 'This field is required when none of from and to are present.'
example: null
type:
type: string
description: ''
example: BEP20
enum:
- BNB
- BEP20
- BEP721
reference:
type: string
description: 'A reference for the webhook. Must not be greater than 255 characters.'
example: 'n'
nullable: true
required:
- url
'/api/v2/bsc/webhooks/{id}':
get:
summary: 'Get webhook'
operationId: getWebhook
description: 'Show the details of a Webhook'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'BSC Webhooks'
put:
summary: 'Update webhook'
operationId: updateWebhook
description: 'Updates an existing webhook with the provided data.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Webhook updated'
data:
id: 9b73d6ee-8a8b-44c3-b2c6-0bd1e1d8cd9a
from: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
to: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
contractaddress: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
type: BEP20
token_id: null
url: 'http://blanda.com/debitis-et-id-nisi-qui-id.html'
is_active: true
is_invalid: false
old_id: null
created_at: '2024-02-29T14:51:35.000000Z'
updated_at: '2024-02-29T14:52:33.000000Z'
deleted_at: null
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook updated'
data:
type: object
properties:
id:
type: string
example: 9b73d6ee-8a8b-44c3-b2c6-0bd1e1d8cd9a
from:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
to:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
contractaddress:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
type:
type: string
example: BEP20
token_id:
type: string
example: null
url:
type: string
example: 'http://blanda.com/debitis-et-id-nisi-qui-id.html'
is_active:
type: boolean
example: true
is_invalid:
type: boolean
example: false
old_id:
type: string
example: null
created_at:
type: string
example: '2024-02-29T14:51:35.000000Z'
updated_at:
type: string
example: '2024-02-29T14:52:33.000000Z'
deleted_at:
type: string
example: null
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: 404
ok: false
message: 'Webhook not found'
data: []
properties:
status:
type: integer
example: 404
ok:
type: boolean
example: false
message:
type: string
example: 'Webhook not found'
data:
type: array
example: []
tags:
- 'BSC Webhooks'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'Sender address (required if not "to"). This field is required when to is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
to:
type: string
description: 'Receiver address (required if not providing "from"). This field is required when from is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
url:
type: string
description: 'URL for webhook notifications (required). Must be a valid URL.'
example: 'http://vonrueden.com/'
contractaddress:
type: string
description: 'The Address of an Contract you want to track (Not allowwed on Bitcoin). This field is required when none of from and to are present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
token_id:
type: string
description: 'This field is required when none of from and to are present.'
example: null
type:
type: string
description: ''
example: BEP20
enum:
- BNB
- BEP20
- BEP721
reference:
type: string
description: 'A reference for the webhook. Must not be greater than 255 characters.'
example: 'n'
nullable: true
required:
- url
delete:
summary: 'Delete webhook'
operationId: deleteWebhook
description: 'This method will delete the specified webhook.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Webhook deleted'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook deleted'
data:
type: array
example: []
tags:
- 'BSC Webhooks'
parameters:
-
in: path
name: id
description: 'The UUID of the webhook you want to show.'
example: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
required: true
schema:
type: string
/api/v2/bsc/webhooks/notifications:
get:
summary: 'Display all Webhook Notifications'
operationId: displayAllWebhookNotifications
description: 'Lists all webhook notifications created by the user for the specific Blockchain and Network'
parameters:
-
in: query
name: page
description: 'The page number to fetch'
example: 16
required: false
schema:
type: integer
description: 'The page number to fetch'
example: 16
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully fetched notifications'
current_page: 1
data:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
from: 1
last_page: 1
last_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications'
per_page: 15
prev_page_url: null
to: 1
total: 1
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully fetched notifications'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
items:
type: object
properties:
id:
type: string
example: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id:
type: string
example: 9ba897da-7651-4df6-80ef-11c898b195e5
txid:
type: string
example: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type:
type: string
example: TRC20
contractaddress:
type: string
example: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from:
type: string
example: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to:
type: string
example: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid:
type: string
example: null
amount:
type: string
example: null
blocknumber:
type: string
example: '19499380'
status:
type: string
example: failed
url:
type: string
example: 'https://example.com'
success:
type: boolean
example: false
attempts:
type: integer
example: 0
created_at:
type: string
example: '2024-05-05T19:33:52.000000Z'
updated_at:
type: string
example: '2024-05-05T19:33:54.000000Z'
network:
type: string
example: testnet
blockchain:
type: string
example: tron
response:
type: string
example: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications'
per_page:
type: integer
example: 15
prev_page_url:
type: string
example: null
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'BSC Webhooks'
/api/v2/bsc/webhooks/notifications/failed:
get:
summary: 'Display all failed Webhook Notification'
operationId: displayAllFailedWebhookNotification
description: "Lists all failed webhook notifications created by the user for the specific Blockchain and Network\nBased on the response you can use our /webhooks/notifications/{id}/retry to retry every failed webhook.\n\nAfter you started the retry process, the webhook will be removed from this list. should the retry process fail, the webhook will be added back to this list."
parameters:
-
in: query
name: page
description: 'The page number to fetch'
example: 16
required: false
schema:
type: integer
description: 'The page number to fetch'
example: 16
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully fetched failed notifications'
current_page: 1
data:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
from: 1
last_page: 1
last_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed'
per_page: 15
prev_page_url: null
to: 1
total: 1
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully fetched failed notifications'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
items:
type: object
properties:
id:
type: string
example: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id:
type: string
example: 9ba897da-7651-4df6-80ef-11c898b195e5
txid:
type: string
example: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type:
type: string
example: TRC20
contractaddress:
type: string
example: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from:
type: string
example: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to:
type: string
example: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid:
type: string
example: null
amount:
type: string
example: null
blocknumber:
type: string
example: '19499380'
status:
type: string
example: failed
url:
type: string
example: 'https://example.com'
success:
type: boolean
example: false
attempts:
type: integer
example: 0
created_at:
type: string
example: '2024-05-05T19:33:52.000000Z'
updated_at:
type: string
example: '2024-05-05T19:33:54.000000Z'
network:
type: string
example: testnet
blockchain:
type: string
example: tron
response:
type: string
example: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed'
per_page:
type: integer
example: 15
prev_page_url:
type: string
example: null
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'BSC Webhooks'
'/api/v2/bsc/webhooks/notifications/{id}/retry':
post:
summary: 'Retry a failed Webhook Notification'
operationId: retryAFailedWebhookNotification
description: 'Retries a failed webhook notification'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses: { }
tags:
- 'BSC Webhooks'
parameters:
-
in: path
name: id
description: 'The ID of the notification.'
example: architecto
required: true
schema:
type: string
/api/v2/solana/addresses:
post:
summary: ''
operationId: postApiV2SolanaAddresses
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses: { }
tags:
- 'Solana Addresses'
/api/v2/solana/blocks/number:
get:
summary: 'Get latest block number'
operationId: getLatestBlockNumber
description: 'This Method returns the latest block number'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
status: 200
ok: true
message: 'Latest block number fetched'
data:
blocknumber: '1000000'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Latest block number fetched'
data:
type: object
properties:
blocknumber:
type: string
example: '1000000'
-
description: ''
type: object
example:
status: 422
ok: false
message: 'Error! Could not get latest block number'
data: 'Error message'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Error! Could not get latest block number'
data:
type: string
example: 'Error message'
tags:
- 'Solana Blockchain Queries'
/api/v2/solana/blocks/hash:
get:
summary: 'Get latest block hash'
operationId: getLatestBlockHash
description: 'This Method returns the latest block hash'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
status: 200
ok: true
message: 'Latest block hash fetched'
data:
block_hash: F9vKcASE4DYZtP96PUqGPXCLotEhN3NWEKyo5byfy6U7
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Latest block hash fetched'
data:
type: object
properties:
block_hash:
type: string
example: F9vKcASE4DYZtP96PUqGPXCLotEhN3NWEKyo5byfy6U7
-
description: ''
type: object
example:
status: 422
ok: false
message: 'Error! Could not get latest block hash'
data: 'Error message'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Error! Could not get latest block hash'
data:
type: string
example: 'Error message'
tags:
- 'Solana Blockchain Queries'
'/api/v2/solana/blocks/{block_number}':
get:
summary: 'Get block by number'
operationId: getBlockByNumber
description: 'This Method returns the block by its number'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
status: 200
ok: true
message: 'Block fetched'
data:
status: 200
ok: true
message: 'Block fetched'
data:
blockHeight: 310208608
blockTime: 1724837646
blockhash: 5JDX97qWQY5QAjCdvQGrmWkPaxX5ZWLPsJWsRfXT9yxS
parentSlot: 321986678
previousBlockhash: 2mTHN3BRv9bpFhdYmJTzrUjdQJm6EYBToXK5VVCwxffX
transactions:
- 23UhFBpkf8iw7n288gfJt5Wk8tNeABK1EWSt3HBR7jDrhdDzNNdcaxwNSYbA8wVssXb53ynVNgvKqppjA4kfcfyA
- 4CGZvbVQNJEdybpNpWcn3nLmpXoK1g15L4md3gHhV14dGvndzhXLGUxLyUdCeiUvyFydQuJVacxsmCCPUBKQkLz5
- 5425j3y3oScNEXfEpGF3zqhKEdtBJJGWjDbCoFc2BEWbK2MCV9daTHuuXoadQJWGrDeQt5m9Bvxf6mnTEGuv2usd
- 2XUJqkXBSBwv1zSBD639kKqKwdvfzKwqnxdvRgNMa2b4ZgxfmCFMD2YQMirh4U77XM4yLtud4ebcK2f3SbLc48Gb
- 4uACwoGKuzzgrYVaUHpLP7de7LXUfYRyQmr17uRw68zkEZhb9zh87oLuSZtNaUoyNGe7TuK6LDYm3NStpd37rdd6
- 5Qc8YjLpghe7rHKVQPSQuANaM2CWP94BKuaombjvsA9rKrzn7DNBqmBpKYLcxDa4T9ZNXM6srpfPKfdB2M16Px16
- 3G4Y4Aio487a3MMmYPecMM6nfVvFbbBN9cbwwHWKX2GjPqBT4xJuMM5aeZP6EsHA5fjdfU53u7LGgXW56u8GSdFF
- 5y6p7yH4xvsTkZ7zcdMeJUiAQUU1mdVmGUQ26HMj9JnvkYNwW5UDVFnYUVcxa4BXNV5Yt1KCQ258f4zvCnbyn83D
- 23TyDocS7jgUzzcrxRiivcgAQZSEF5b9VavWqooz9yDxRqEp5owwPAq2mcsqzWmyb9iwYbwxseq491TQv2sAEucr
- 5xsid9wB7QDu7hDNXQvRDPcbV7nJm8gPai6iZ13tTsgZEY45rgzUupZuHJFFDAsSMvBdseWJeY5oZu2EQ2bfdhid
- 44yPy6BKPB3qoWgB8NbXmSGuHc8CF9o7AK93GKoZMUddLWsmSEK8jVgR8TsKN1Lw32xraKTHbquTWTwLQqrDY5yJ
- 3qvnBuNdu8Qk2oK46zne8zmLAMTMSTtGXv8FRUiZRuXzVLXEZ87B8F6kUxVheWuSCLiALcVs5iMDfCoCaYwpJump
- 4UacSw5d1LCKKSjXKKXfas4JkYaVEjcCEjXnN3dtheYYn5cEKkNrNne2LmJmsMQgKjiq62nBfTbNuv7Vr6nppLPs
- 2yv5wUtChaGzQyyQFn3sivxFippiqUhCUs8Q7KJYy5UWfx9Ni9AmC3VinZNCJKWJC318kYQmVQYX4BjC3jBmXu7h
- 3Gr1sP8y8ECGRrQkGvrQRBpEKLvyiNZR2gsxZGZ5MouD3t3nztQ6iF6w6YzHjSRJEhR1Cu6z3F9Qf1PqjDbfuNni
- 2z5NwPdVbu4XEyS34yMmNw8rrzuJiV7sCg3K9kNKpvnHC4erAz2ZqfZzXpCMcra7CUPah7uy4W4j1JozuY5BsMsr
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Block fetched'
data:
type: object
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Block fetched'
data:
type: object
properties:
blockHeight:
type: integer
example: 310208608
blockTime:
type: integer
example: 1724837646
blockhash:
type: string
example: 5JDX97qWQY5QAjCdvQGrmWkPaxX5ZWLPsJWsRfXT9yxS
parentSlot:
type: integer
example: 321986678
previousBlockhash:
type: string
example: 2mTHN3BRv9bpFhdYmJTzrUjdQJm6EYBToXK5VVCwxffX
transactions:
type: array
example:
- 23UhFBpkf8iw7n288gfJt5Wk8tNeABK1EWSt3HBR7jDrhdDzNNdcaxwNSYbA8wVssXb53ynVNgvKqppjA4kfcfyA
- 4CGZvbVQNJEdybpNpWcn3nLmpXoK1g15L4md3gHhV14dGvndzhXLGUxLyUdCeiUvyFydQuJVacxsmCCPUBKQkLz5
- 5425j3y3oScNEXfEpGF3zqhKEdtBJJGWjDbCoFc2BEWbK2MCV9daTHuuXoadQJWGrDeQt5m9Bvxf6mnTEGuv2usd
- 2XUJqkXBSBwv1zSBD639kKqKwdvfzKwqnxdvRgNMa2b4ZgxfmCFMD2YQMirh4U77XM4yLtud4ebcK2f3SbLc48Gb
- 4uACwoGKuzzgrYVaUHpLP7de7LXUfYRyQmr17uRw68zkEZhb9zh87oLuSZtNaUoyNGe7TuK6LDYm3NStpd37rdd6
- 5Qc8YjLpghe7rHKVQPSQuANaM2CWP94BKuaombjvsA9rKrzn7DNBqmBpKYLcxDa4T9ZNXM6srpfPKfdB2M16Px16
- 3G4Y4Aio487a3MMmYPecMM6nfVvFbbBN9cbwwHWKX2GjPqBT4xJuMM5aeZP6EsHA5fjdfU53u7LGgXW56u8GSdFF
- 5y6p7yH4xvsTkZ7zcdMeJUiAQUU1mdVmGUQ26HMj9JnvkYNwW5UDVFnYUVcxa4BXNV5Yt1KCQ258f4zvCnbyn83D
- 23TyDocS7jgUzzcrxRiivcgAQZSEF5b9VavWqooz9yDxRqEp5owwPAq2mcsqzWmyb9iwYbwxseq491TQv2sAEucr
- 5xsid9wB7QDu7hDNXQvRDPcbV7nJm8gPai6iZ13tTsgZEY45rgzUupZuHJFFDAsSMvBdseWJeY5oZu2EQ2bfdhid
- 44yPy6BKPB3qoWgB8NbXmSGuHc8CF9o7AK93GKoZMUddLWsmSEK8jVgR8TsKN1Lw32xraKTHbquTWTwLQqrDY5yJ
- 3qvnBuNdu8Qk2oK46zne8zmLAMTMSTtGXv8FRUiZRuXzVLXEZ87B8F6kUxVheWuSCLiALcVs5iMDfCoCaYwpJump
- 4UacSw5d1LCKKSjXKKXfas4JkYaVEjcCEjXnN3dtheYYn5cEKkNrNne2LmJmsMQgKjiq62nBfTbNuv7Vr6nppLPs
- 2yv5wUtChaGzQyyQFn3sivxFippiqUhCUs8Q7KJYy5UWfx9Ni9AmC3VinZNCJKWJC318kYQmVQYX4BjC3jBmXu7h
- 3Gr1sP8y8ECGRrQkGvrQRBpEKLvyiNZR2gsxZGZ5MouD3t3nztQ6iF6w6YzHjSRJEhR1Cu6z3F9Qf1PqjDbfuNni
- 2z5NwPdVbu4XEyS34yMmNw8rrzuJiV7sCg3K9kNKpvnHC4erAz2ZqfZzXpCMcra7CUPah7uy4W4j1JozuY5BsMsr
items:
type: string
-
description: ''
type: object
example:
status: 422
ok: false
message: 'Error! Could not get block'
data: 'Error message'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Error! Could not get block'
data:
type: string
example: 'Error message'
tags:
- 'Solana Blockchain Queries'
parameters:
-
in: path
name: block_number
description: 'The block number'
example: '321986679'
required: true
schema:
type: string
'/api/v2/solana/balances/{address}':
get:
summary: 'Get Account Balance'
operationId: getAccountBalance
description: 'Result is in SOL'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Balance fetched'
data:
balance: '0.5'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Balance fetched'
data:
type: object
properties:
balance:
type: string
example: '0.5'
tags:
- 'Solana Blockchain Queries'
parameters:
-
in: path
name: address
description: 'The address to get the balance for'
example: 8xifUt1SV7mA1sKFdMYcJ8ZmhDWhoadbfeZ7Jm7NA3jb
required: true
schema:
type: string
'/api/v2/solana/balances/{address}/tokens/{mint}':
get:
summary: 'Get Token Balance'
operationId: getTokenBalance
description: 'Get the Balance of a SPL-Token for a specific address'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Balance fetched'
data:
balance: '0.3'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Balance fetched'
data:
type: object
properties:
balance:
type: string
example: '0.3'
tags:
- 'Solana Blockchain Queries'
parameters:
-
in: path
name: address
description: 'The address to get the balance for'
example: dv2eQHeP4RFrJZ6UeiZWoc3XTtmtZCUKxxCApCDcRNV
required: true
schema:
type: string
-
in: path
name: mint
description: ''
example: architecto
required: true
schema:
type: string
-
in: path
name: contractaddress
description: 'The mint of the token'
example: 4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU
required: true
schema:
type: string
'/api/v2/solana/tokens/{mint}':
get:
summary: 'Get Token Information'
operationId: getTokenInformation
description: 'Get the information of a SPL-Token'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Token information fetched'
data:
mint: Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB
symbol: USDT
name: USDT
uri: ''
decimals: 6
amount: 1889937989.6564
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Token information fetched'
data:
type: object
properties:
mint:
type: string
example: Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB
symbol:
type: string
example: USDT
name:
type: string
example: USDT
uri:
type: string
example: ''
decimals:
type: integer
example: 6
amount:
type: number
example: 1889937989.6564
tags:
- 'Solana Blockchain Queries'
parameters:
-
in: path
name: mint
description: ''
example: architecto
required: true
schema:
type: string
-
in: path
name: contractaddress
description: 'The mint of the token'
example: 4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU
required: true
schema:
type: string
'/api/v2/solana/nfts/{mint}':
get:
summary: 'Get NFT Information'
operationId: getNFTInformation
description: 'Get the information of a NFT-Token'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'NFT information fetched'
data:
mint: HVjE8yC2ANwyP9TVNBD5yvEhLESWjdnYvK5TKiEhm3gp
name: dogwifhat
uri: 'https://nftstorage.link/ipfs/bafkreicwwumzhnhwk7oowsg4yud2ajfw4x5xdwoatjcdoptuanb3xwuzbu'
symbol: ''
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'NFT information fetched'
data:
type: object
properties:
mint:
type: string
example: HVjE8yC2ANwyP9TVNBD5yvEhLESWjdnYvK5TKiEhm3gp
name:
type: string
example: dogwifhat
uri:
type: string
example: 'https://nftstorage.link/ipfs/bafkreicwwumzhnhwk7oowsg4yud2ajfw4x5xdwoatjcdoptuanb3xwuzbu'
symbol:
type: string
example: ''
tags:
- 'Solana Blockchain Queries'
parameters:
-
in: path
name: mint
description: ''
example: architecto
required: true
schema:
type: string
-
in: path
name: contractaddress
description: 'The mint of the token'
example: HVjE8yC2ANwyP9TVNBD5yvEhLESWjdnYvK5TKiEhm3gp
required: true
schema:
type: string
'/api/v2/solana/nfts/{mint}/uri':
get:
summary: 'Get NFT URI'
operationId: getNFTURI
description: 'Get the URI of a NFT-Token'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'NFT URI fetched'
data:
uri: 'https:\/\/arweave.net\/cHldb-hpgkWz6bBXWj7ee6M-QBDtBSLDBO77dvsZG4I'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'NFT URI fetched'
data:
type: object
properties:
uri:
type: string
example: 'https:\/\/arweave.net\/cHldb-hpgkWz6bBXWj7ee6M-QBDtBSLDBO77dvsZG4I'
tags:
- 'Solana Blockchain Queries'
parameters:
-
in: path
name: mint
description: ''
example: architecto
required: true
schema:
type: string
-
in: path
name: contractaddress
description: 'The mint of the token'
example: HVjE8yC2ANwyP9TVNBD5yvEhLESWjdnYvK5TKiEhm3gp
required: true
schema:
type: string
'/api/v2/solana/nfts/{mint}/owner':
get:
summary: 'Get NFT Owner'
operationId: getNFTOwner
description: 'Get the owner of a NFT-Token'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'NFT owner fetched'
data:
owner: Acm5xtTL9GMbKDT7NFRphNfnCHtio9UEBX3cg5wwxJda
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'NFT owner fetched'
data:
type: object
properties:
owner:
type: string
example: Acm5xtTL9GMbKDT7NFRphNfnCHtio9UEBX3cg5wwxJda
tags:
- 'Solana Blockchain Queries'
parameters:
-
in: path
name: mint
description: ''
example: architecto
required: true
schema:
type: string
-
in: path
name: contractaddress
description: 'The mint of the token'
example: HVjE8yC2ANwyP9TVNBD5yvEhLESWjdnYvK5TKiEhm3gp
required: true
schema:
type: string
/api/v2/solana/transactions:
get:
summary: ''
operationId: getApiV2SolanaTransactions
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Solana Transactions'
post:
summary: 'Create SOL Transaction'
operationId: createSOLTransaction
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses: { }
tags:
- 'Solana Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The sender address of the transaction. Must match the regex /^[1-9A-HJ-NP-Za-km-z]{32,44}$/.'
example: 9f8f72aa9304c8b593d555f12ef6589cc3a579a2
to:
type: string
description: 'The receiver address of the transaction. Must match the regex /^[1-9A-HJ-NP-Za-km-z]{32,44}$/.'
example: 9f8f72aa9304c8b593d555f12ef6589cc3a579a2
amount:
type: number
description: 'The amount to send in SOL.'
example: 100.0
privatekey:
type: string
description: 'The private key to sign the transaction.'
example: 9f8f72aa9304c8b593d555f12ef6589cc3a579a2
required:
- from
- to
- amount
- privatekey
'/api/v2/solana/transactions/{txid}':
get:
summary: 'Get Transaction'
operationId: getTransaction
description: 'This Method will return the transaction details'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Solana Transactions'
parameters:
-
in: path
name: txid
description: ''
example: architecto
required: true
schema:
type: string
'/api/v2/solana/transactions/{txid}/decoded':
get:
summary: 'Get decoded Transaction'
operationId: getDecodedTransaction
description: 'This Method will return the decoded transaction details'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Solana Transactions'
parameters:
-
in: path
name: txid
description: ''
example: architecto
required: true
schema:
type: string
/api/v2/solana/transactions/SPL:
post:
summary: 'Create SPL Token Transaction'
operationId: createSPLTokenTransaction
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses: { }
tags:
- 'Solana Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The sender address of the transaction. Must match the regex /^[1-9A-HJ-NP-Za-km-z]{32,44}$/.'
example: 9f8f72aa9304c8b593d555f12ef6589cc3a579a2
to:
type: string
description: 'The receiver address of the transaction. Must match the regex /^[1-9A-HJ-NP-Za-km-z]{32,44}$/.'
example: 9f8f72aa9304c8b593d555f12ef6589cc3a579a2
contractaddress:
type: string
description: 'The mint address of the token. Must match the regex /^[1-9A-HJ-NP-Za-km-z]{32,44}$/.'
example: 9f8f72aa9304c8b593d555f12ef6589cc3a579a2
amount:
type: number
description: 'The amount to send in SOL.'
example: 100.0
privatekey:
type: string
description: 'The private key to sign the transaction.'
example: 9f8f72aa9304c8b593d555f12ef6589cc3a579a2
required:
- from
- to
- contractaddress
- amount
- privatekey
/api/v2/polygon/blocks/number:
get:
summary: 'Get latest block number'
operationId: getLatestBlockNumber
description: 'This Method returns the latest block number'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Latest block number fetched'
type: object
example:
status: 200
ok: true
message: 'Latest block number fetched'
data:
blocknumber: 123456
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Latest block number fetched'
data:
type: object
properties:
blocknumber:
type: integer
example: 123456
-
description: ''
type: object
example:
status: 200
ok: true
message: 'Latest block number fetched'
data: 19151363
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Latest block number fetched'
data:
type: integer
example: 19151363
tags:
- 'Polygon Blockchain Queries'
'/api/v2/polygon/blocks/{block_number}':
get:
summary: 'Get block by number or hash'
operationId: getBlockByNumberOrHash
description: 'This Method returns the block by its number'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Block fetched'
type: object
example:
status: 200
ok: true
message: 'Block fetched'
data:
difficulty: 16
extraData: '0xd482020a83626f7286676f312e3137856c696e75780000000000000000000000fb14f09854175ad6379c2fce286a474ba103fe8270c97ab4ce4a89949c00c54a1b38740f620ab9b66e0991804d4adc2c85baba80efc3a802aec73d8f2a2bd88600'
gasLimit: 20836455
gasUsed: '0xdc0281'
hash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
logsBloom: '0x0b759230fd529cda05e9663e8cd2f1a5c4b9b92cece1108b0a7391043fa15d44f89f59a86c6674183a5392d0a35d6405d1f48edb3a4aa428a01ac5ed02eea24d1415580c028451b5d871ca4b9ea14db59c32c64a25d43d0781137d5ea23dae24540ee29fa305a28818a8125b06c08d7c0944c460958d4e09bce2497003cf53b21121ffc2cc8922cb54953f0839834f2c968367b94a369bf8d22beccf40a03216facc84a11687df580810e0e2219871a97253a0231b262010009ca148390c11759b10064ffece08511de701bca853adf6dc60c049d4a9a01a00f9fe8fa302e385415248ff66840241e094908201a181048f1420a92ac90e41080c4fa10918599c'
miner: '0x0000000000000000000000000000000000000000'
mixHash: '0x0000000000000000000000000000000000000000000000000000000000000000'
nonce: '0x0000000000000000'
number: 21785493
parentHash: '0x8cacb1ad30d3623f3ed01eb4a6b8990de88a50a4c9c3380ee0f3bb63cfd290ce'
receiptsRoot: '0x8507f82a9c3fe4dc02d8ca6bd332c06db723cd9f3148bf65ed81b5ab2533db11'
sha3Uncles: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347'
size: 60687
stateRoot: '0x1e428a1eacaec62d26c2e410d76baf66ae7f598f3cee8eda5c0e94656576426f'
timestamp: '2021-11-25 13:19:46'
totalDifficulty: 261320853
transactions:
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0xe898563caf3b8ed945bd23e9f1a5eca1f395180e'
gas: '0x203c76'
gasPrice: '0x53d1ac1000'
hash: '0xd664519ee6a2bab1031da8e56f814d9626878de9aedef2426a5356d572280f97'
input: '0x38ed1739000000000000000000000000000000000000000000000000193e8f3326c4db0000000000000000000000000000000000000000000000000000b9a333dce606c800000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000e898563caf3b8ed945bd23e9f1a5eca1f395180e00000000000000000000000000000000000000000000000000000000619f915700000000000000000000000000000000000000000000000000000000000000020000000000000000000000002c89bbc92bd86f8075d1decc58c7f4e0107f286b0000000000000000000000007ceb23fd6bc0add59e62ac25578270cff1b9f619'
nonce: '0x168ac'
to: '0x1b02da8cb0d097eb8d57a175b88c7d8b47997506'
transactionIndex: '0x0'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x136'
r: '0xa1ac2567f13ba553713d4f21db8eb3617c04d51d7ed81964516aac8142528f52'
s: '0x11ac82d2353d6441f6bf1e182fbfae73b315461d1283f8048098311aac699b6f'
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0x41bf9148a378a12f0bf5d0ae050f2b72fd8fc290'
gas: '0x9aeb'
gasPrice: '0x14f46b0400'
hash: '0x65c649006ca5b5812d27b141b7620c884bdcf0b55872e2c879ce7e119bb92e40'
input: '0x2e1a7d4d00000000000000000000000000000000000000000000000d8d726b7177a80000'
nonce: '0xd'
to: '0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270'
transactionIndex: '0xe'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x135'
r: '0xac00b4880ad2d11d8443aca6e2b097e491fb5fe48466de30d12655b882d3b85f'
s: '0x377d1b9bb9bfbc3d565f34910240bd2cb81791dcf2016d07e595f1ada2c7ce15'
-
- '... More transactions here'
transactionsRoot: '0xdbab0c76f6a233225148be047c007572ffd7bd49b08d4da30c0a32fb5ae1ae02'
uncles: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Block fetched'
data:
type: object
properties:
difficulty:
type: integer
example: 16
extraData:
type: string
example: '0xd482020a83626f7286676f312e3137856c696e75780000000000000000000000fb14f09854175ad6379c2fce286a474ba103fe8270c97ab4ce4a89949c00c54a1b38740f620ab9b66e0991804d4adc2c85baba80efc3a802aec73d8f2a2bd88600'
gasLimit:
type: integer
example: 20836455
gasUsed:
type: string
example: '0xdc0281'
hash:
type: string
example: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
logsBloom:
type: string
example: '0x0b759230fd529cda05e9663e8cd2f1a5c4b9b92cece1108b0a7391043fa15d44f89f59a86c6674183a5392d0a35d6405d1f48edb3a4aa428a01ac5ed02eea24d1415580c028451b5d871ca4b9ea14db59c32c64a25d43d0781137d5ea23dae24540ee29fa305a28818a8125b06c08d7c0944c460958d4e09bce2497003cf53b21121ffc2cc8922cb54953f0839834f2c968367b94a369bf8d22beccf40a03216facc84a11687df580810e0e2219871a97253a0231b262010009ca148390c11759b10064ffece08511de701bca853adf6dc60c049d4a9a01a00f9fe8fa302e385415248ff66840241e094908201a181048f1420a92ac90e41080c4fa10918599c'
miner:
type: string
example: '0x0000000000000000000000000000000000000000'
mixHash:
type: string
example: '0x0000000000000000000000000000000000000000000000000000000000000000'
nonce:
type: string
example: '0x0000000000000000'
number:
type: integer
example: 21785493
parentHash:
type: string
example: '0x8cacb1ad30d3623f3ed01eb4a6b8990de88a50a4c9c3380ee0f3bb63cfd290ce'
receiptsRoot:
type: string
example: '0x8507f82a9c3fe4dc02d8ca6bd332c06db723cd9f3148bf65ed81b5ab2533db11'
sha3Uncles:
type: string
example: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347'
size:
type: integer
example: 60687
stateRoot:
type: string
example: '0x1e428a1eacaec62d26c2e410d76baf66ae7f598f3cee8eda5c0e94656576426f'
timestamp:
type: string
example: '2021-11-25 13:19:46'
totalDifficulty:
type: integer
example: 261320853
transactions:
type: array
example:
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0xe898563caf3b8ed945bd23e9f1a5eca1f395180e'
gas: '0x203c76'
gasPrice: '0x53d1ac1000'
hash: '0xd664519ee6a2bab1031da8e56f814d9626878de9aedef2426a5356d572280f97'
input: '0x38ed1739000000000000000000000000000000000000000000000000193e8f3326c4db0000000000000000000000000000000000000000000000000000b9a333dce606c800000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000e898563caf3b8ed945bd23e9f1a5eca1f395180e00000000000000000000000000000000000000000000000000000000619f915700000000000000000000000000000000000000000000000000000000000000020000000000000000000000002c89bbc92bd86f8075d1decc58c7f4e0107f286b0000000000000000000000007ceb23fd6bc0add59e62ac25578270cff1b9f619'
nonce: '0x168ac'
to: '0x1b02da8cb0d097eb8d57a175b88c7d8b47997506'
transactionIndex: '0x0'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x136'
r: '0xa1ac2567f13ba553713d4f21db8eb3617c04d51d7ed81964516aac8142528f52'
s: '0x11ac82d2353d6441f6bf1e182fbfae73b315461d1283f8048098311aac699b6f'
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0x41bf9148a378a12f0bf5d0ae050f2b72fd8fc290'
gas: '0x9aeb'
gasPrice: '0x14f46b0400'
hash: '0x65c649006ca5b5812d27b141b7620c884bdcf0b55872e2c879ce7e119bb92e40'
input: '0x2e1a7d4d00000000000000000000000000000000000000000000000d8d726b7177a80000'
nonce: '0xd'
to: '0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270'
transactionIndex: '0xe'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x135'
r: '0xac00b4880ad2d11d8443aca6e2b097e491fb5fe48466de30d12655b882d3b85f'
s: '0x377d1b9bb9bfbc3d565f34910240bd2cb81791dcf2016d07e595f1ada2c7ce15'
-
- '... More transactions here'
items:
type: object
properties:
blockHash:
type: string
example: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber:
type: string
example: '0x14c6b95'
from:
type: string
example: '0xe898563caf3b8ed945bd23e9f1a5eca1f395180e'
gas:
type: string
example: '0x203c76'
gasPrice:
type: string
example: '0x53d1ac1000'
hash:
type: string
example: '0xd664519ee6a2bab1031da8e56f814d9626878de9aedef2426a5356d572280f97'
input:
type: string
example: '0x38ed1739000000000000000000000000000000000000000000000000193e8f3326c4db0000000000000000000000000000000000000000000000000000b9a333dce606c800000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000e898563caf3b8ed945bd23e9f1a5eca1f395180e00000000000000000000000000000000000000000000000000000000619f915700000000000000000000000000000000000000000000000000000000000000020000000000000000000000002c89bbc92bd86f8075d1decc58c7f4e0107f286b0000000000000000000000007ceb23fd6bc0add59e62ac25578270cff1b9f619'
nonce:
type: string
example: '0x168ac'
to:
type: string
example: '0x1b02da8cb0d097eb8d57a175b88c7d8b47997506'
transactionIndex:
type: string
example: '0x0'
value:
type: string
example: '0x0'
type:
type: string
example: '0x0'
chainId:
type: string
example: '0x89'
v:
type: string
example: '0x136'
r:
type: string
example: '0xa1ac2567f13ba553713d4f21db8eb3617c04d51d7ed81964516aac8142528f52'
s:
type: string
example: '0x11ac82d2353d6441f6bf1e182fbfae73b315461d1283f8048098311aac699b6f'
transactionsRoot:
type: string
example: '0xdbab0c76f6a233225148be047c007572ffd7bd49b08d4da30c0a32fb5ae1ae02'
uncles:
type: array
example: []
-
description: ''
type: object
nullable: true
tags:
- 'Polygon Blockchain Queries'
parameters:
-
in: path
name: block_number
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '19151363'
/api/v2/polygon/transactions:
get:
summary: 'List Transactions'
operationId: listTransactions
description: "This method lists your transaction history. It lists all transactions including ERC20 and ERC721 transactions.
\n Please note that we dont index your addresses. We list only transactions that were made with the Chaingateway API"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Paginated result'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transactions'
current_page: 1
data:
-
id: 1
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.001000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T09:00:18.000000Z'
updated_at: '2024-02-13T09:00:18.000000Z'
-
id: 4
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0x5da4f33531fab8ecfe6f36a1300265f772b5f11c2da736a39b0b4b0c1b97c3e2'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.384200000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:01:26.000000Z'
updated_at: '2024-02-13T10:01:26.000000Z'
-
id: 5
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x1b7ecf53527e9a9ec09c448b2f594357e8a09f52c02c96d0de33fe435750d371'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:34:34.000000Z'
updated_at: '2024-02-13T10:34:34.000000Z'
-
id: 6
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x5b293a7289e8405fb8402f0bfa6e7464fdc9bfbc11aaa7874d4a7216b4079729'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:35:57.000000Z'
updated_at: '2024-02-13T10:35:57.000000Z'
-
id: 7
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x8830bd8d0cf0dfeac6d4cc345888ae52f9ca8b3a3cf37859919786bd9cd8ae2f'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '100.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:22:03.000000Z'
updated_at: '2024-02-13T12:22:03.000000Z'
-
id: 8
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:36:48.000000Z'
updated_at: '2024-02-13T12:36:48.000000Z'
first_page_url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
from: 1
last_page: 1
last_page_url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions'
per_page: 50
prev_page_url: null
to: 6
total: 6
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transactions'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 1
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.001000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T09:00:18.000000Z'
updated_at: '2024-02-13T09:00:18.000000Z'
-
id: 4
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0x5da4f33531fab8ecfe6f36a1300265f772b5f11c2da736a39b0b4b0c1b97c3e2'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.384200000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:01:26.000000Z'
updated_at: '2024-02-13T10:01:26.000000Z'
-
id: 5
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x1b7ecf53527e9a9ec09c448b2f594357e8a09f52c02c96d0de33fe435750d371'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:34:34.000000Z'
updated_at: '2024-02-13T10:34:34.000000Z'
-
id: 6
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x5b293a7289e8405fb8402f0bfa6e7464fdc9bfbc11aaa7874d4a7216b4079729'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:35:57.000000Z'
updated_at: '2024-02-13T10:35:57.000000Z'
-
id: 7
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x8830bd8d0cf0dfeac6d4cc345888ae52f9ca8b3a3cf37859919786bd9cd8ae2f'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '100.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:22:03.000000Z'
updated_at: '2024-02-13T12:22:03.000000Z'
-
id: 8
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:36:48.000000Z'
updated_at: '2024-02-13T12:36:48.000000Z'
items:
type: object
properties:
id:
type: integer
example: 1
user_id:
type: integer
example: 1
blockchain:
type: string
example: bsc
network:
type: string
example: testnet
type:
type: string
example: default
txid:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from:
type: string
example: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to:
type: string
example: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress:
type: string
example: null
amount:
type: string
example: '0.001000000000'
tokenid:
type: string
example: null
responseJson:
type: string
example: null
httpStatus:
type: string
example: null
created_at:
type: string
example: '2024-02-13T09:00:18.000000Z'
updated_at:
type: string
example: '2024-02-13T09:00:18.000000Z'
first_page_url:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions'
per_page:
type: integer
example: 50
prev_page_url:
type: string
example: null
to:
type: integer
example: 6
total:
type: integer
example: 6
tags:
- 'Polygon Transactions'
post:
summary: 'Create transaction'
operationId: createTransaction
description: 'This method creates a new transaction.
'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created'
data:
adderess: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created'
data:
type: object
properties:
adderess:
type: string
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
401:
description: 'Wrong password'
content:
application/json:
schema:
type: object
example:
status: 401
ok: false
message: 'Wrong password provided'
errors: []
properties:
status:
type: integer
example: 401
ok:
type: boolean
example: false
message:
type: string
example: 'Wrong password provided'
errors:
type: array
example: []
422:
description: 'Insufficent funds'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors:
type: array
example: []
tags:
- 'Polygon Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
amount:
type: string
description: 'The amount to send.'
example: '1000000000000000000'
gas:
type: integer
description: 'The gas limit for the transaction.'
example: 21000
gasprice:
type: number
description: 'The gas price for the transaction.'
example: 1000000000.0
maxPriorityFeePerGas:
type: number
description: 'The maximum priority fee per gas for the transaction.'
example: 1000000000.0
maxFeePerGas:
type: number
description: 'The maximum fee per gas for the transaction.'
example: 1000000000.0
password:
type: string
description: 'The password for the wallet. This field is required when privatekey is not present.'
example: password
privatekey:
type: string
description: ''
example: architecto
data:
type: string
description: 'The data for the transaction.'
example: 0x
nonce:
type: string
description: 'The nonce for the transaction.'
example: '0'
required:
- from
- to
- amount
parameters:
-
in: path
name: page
description: 'Optional parameter. The page number'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '1'
'/api/v2/polygon/transactions/{txid}':
get:
summary: 'Get transaction'
operationId: getTransaction
description: 'This method shows a transaction'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: Decoded
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction'
data:
transaction:
blockHash: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber: '37701506'
from: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gas: '21000'
gasPrice: '3.0000000000'
hash: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
nonce: '14'
to: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionIndex: '8'
maxFeePerGas: null
maxPriorityFeePerGas: null
amount: '0.001000000000000000'
contractaddress: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
type: ETH
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction'
data:
type: object
properties:
transaction:
type: object
properties:
blockHash:
type: string
example: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber:
type: string
example: '37701506'
from:
type: string
example: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gas:
type: string
example: '21000'
gasPrice:
type: string
example: '3.0000000000'
hash:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
nonce:
type: string
example: '14'
to:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionIndex:
type: string
example: '8'
maxFeePerGas:
type: string
example: null
maxPriorityFeePerGas:
type: string
example: null
amount:
type: string
example: '0.001000000000000000'
contractaddress:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
type:
type: string
example: ETH
422:
description: 'Transaction not found'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'transaction not found'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'transaction not found'
errors:
type: array
example: []
tags:
- 'Polygon Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
-
in: path
name: decoded
description: "Optional parameter. If set to 'decoded' it will return the decoded transaction"
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: decoded
'/api/v2/polygon/transactions/{txid}/decoded':
get:
summary: 'Get decoded transaction'
operationId: getDecodedTransaction
description: 'This method will decode the transaction and shows you human readable data of the transaction'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Transaction not found'
type: object
example:
status: 422
ok: false
message: 'transaction not found'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'transaction not found'
errors:
type: array
example: []
-
description: 'Transaction fetched'
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction'
data:
blockHash: '0x00bb7d10d61156c1972c8f817ac6bf408b8495a6484492f95ebad57f89fed581'
blockNumber: '67604928'
from: '0x899abf76af40336006df10b71680b925aa86b6f7'
gas: '93835'
gasPrice: '136.9438649750'
maxFeePerGas: '141.3817174220'
maxPriorityFeePerGas: '25.0000000000'
hash: '0x4409ddadf59391177b72ac005e88c3a334887f11ef552356e16477a13a671dd8'
input: '0x954093c40000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000003643aa6479e5a06fc30000000000000000000000000000000000000000000000000000000067a49a2c'
nonce: '174853'
to: '0xbce8b135053c6b9665c09c23d1ef422c48d00ab4'
transactionIndex: '122'
amount: '0'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction'
data:
type: object
properties:
blockHash:
type: string
example: '0x00bb7d10d61156c1972c8f817ac6bf408b8495a6484492f95ebad57f89fed581'
blockNumber:
type: string
example: '67604928'
from:
type: string
example: '0x899abf76af40336006df10b71680b925aa86b6f7'
gas:
type: string
example: '93835'
gasPrice:
type: string
example: '136.9438649750'
maxFeePerGas:
type: string
example: '141.3817174220'
maxPriorityFeePerGas:
type: string
example: '25.0000000000'
hash:
type: string
example: '0x4409ddadf59391177b72ac005e88c3a334887f11ef552356e16477a13a671dd8'
input:
type: string
example: '0x954093c40000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000003643aa6479e5a06fc30000000000000000000000000000000000000000000000000000000067a49a2c'
nonce:
type: string
example: '174853'
to:
type: string
example: '0xbce8b135053c6b9665c09c23d1ef422c48d00ab4'
transactionIndex:
type: string
example: '122'
amount:
type: string
example: '0'
tags:
- 'Polygon Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
-
in: path
name: decoded
description: "Optional parameter. If set to 'decoded' it will return the decoded transaction"
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: decoded
/api/v2/polygon/addresses:
post:
summary: 'Create Address'
operationId: createAddress
description: "Creates a new address wich can be used to send and receive crypto currencies, ERC20 and ERC721 tokens.\nplease provide a stron password within the request body. You will need the password everytime you interact with your address.\n\nThere are two ways to create an Address:\n- unsecure: You will directly get the private key of your address which can be used to create transactions\n- secure: You define a password, the privatekley will use this password as well as our own encryption chain to store the privatekey on our database. You can use this password instead of a private key to create transactions\n\n\n"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Address created'
data:
adderess: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Address created'
data:
type: object
properties:
adderess:
type: string
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
-
description: ''
type: object
example:
status: 422
ok: false
message: 'Your address limit exceeded. Please upgrade your plan'
data: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Your address limit exceeded. Please upgrade your plan'
data:
type: array
example: []
tags:
- 'Polygon Addresses'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
get:
summary: 'List addresses'
operationId: listAddresses
description: 'Lists all addresses you have created but not yet deleted'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Polygon Addresses'
'/api/v2/polygon/addresses/{address}':
delete:
summary: 'Delete Address'
operationId: deleteAddress
description: 'This method will delete your address. This decreases your used address metrics'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Address deleted'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Address deleted'
data:
type: array
example: []
tags:
- 'Polygon Addresses'
post:
summary: 'Update Address Password'
operationId: updateAddressPassword
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Password updated'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Password updated'
data:
type: array
example: []
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- 'Polygon Addresses'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
old_password:
type: string
description: 'The old password of the user.'
example: old_password123
new_password:
type: string
description: 'The new password of the user.'
example: new_password123
required:
- old_password
- new_password
parameters:
-
in: path
name: address
description: 'The address you want to delete.'
example: '0xd280406b68901ae4F2431d1830dF5232F49C19fA'
required: true
schema:
type: string
'/api/v2/polygon/balances/{address}':
get:
summary: 'Get balance of an address'
operationId: getBalanceOfAnAddress
description: 'Get the balance of an address'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Balance fetched'
data: '0.000000000000000000'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Balance fetched'
data:
type: string
example: '0.000000000000000000'
tags:
- 'Polygon Blockchain Queries'
parameters:
-
in: path
name: address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0x45cC557f9E473B1fbB2538aBfd2F27a4C9195acC'
'/api/v2/polygon/balances/{address}/erc20/{contract_address}':
get:
summary: 'Get balance of an ERC20 token'
operationId: getBalanceOfAnERC20Token
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
200:
description: ''
content:
application/json:
schema:
type: string
example: '{ "status": 200, "ok": true, "message": "ERC20 balance fetched", "data": "0.000000" }'
tags:
- 'Polygon Blockchain Queries'
parameters:
-
in: path
name: address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0x45cC557f9E473B1fbB2538aBfd2F27a4C9195acC'
-
in: path
name: contract_address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0xc2132D05D31c914a87C6611C10748AEb04B58e8F'
'/api/v2/polygon/addresses/export/{address}':
post:
summary: ''
operationId: postApiV2PolygonAddressesExportAddress
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Private key exported'
data:
private_key: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Private key exported'
data:
type: object
properties:
private_key:
type: string
example: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- 'Polygon Addresses'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
parameters:
-
in: path
name: address
description: ''
example: architecto
required: true
schema:
type: string
/api/v2/polygon/addresses/import:
post:
summary: 'Import Private Key'
operationId: importPrivateKey
description: 'Import a Private key to use the secure wallet functionality for transactions.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Address imported successfully'
data: []
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Address imported successfully'
data:
type: array
example: []
tags:
- 'Polygon Addresses'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
address:
type: string
description: ''
example: architecto
privatekey:
type: string
description: ''
example: architecto
password:
type: string
description: ''
example: architecto
required:
- address
- privatekey
- password
/api/v2/polygon/transactions/erc20:
post:
summary: 'Create ERC20 transaction'
operationId: createERC20Transaction
description: 'This method creates a new ERC20 transaction.
'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created'
data:
adderess: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created'
data:
type: object
properties:
adderess:
type: string
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
401:
description: 'Wrong password'
content:
application/json:
schema:
type: object
example:
status: 401
ok: false
message: 'Wrong password provided'
errors: []
properties:
status:
type: integer
example: 401
ok:
type: boolean
example: false
message:
type: string
example: 'Wrong password provided'
errors:
type: array
example: []
422:
description: 'Insufficent funds'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors:
type: array
example: []
tags:
- 'Polygon Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
contractaddress:
type: string
description: 'The address of the ERC20 contract. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
gas:
type: integer
description: 'The gas limit for the transaction.'
example: 21000
gasprice:
type: number
description: 'The gas price for the transaction.'
example: 1000000000.0
maxPriorityFeePerGas:
type: number
description: 'The maximum priority fee per gas for the transaction.'
example: 1000000000.0
maxFeePerGas:
type: number
description: 'The maximum fee per gas for the transaction.'
example: 1000000000.0
password:
type: string
description: 'The password to unlock the wallet if you working with a password protected wallet created with chaingateway. . This field is required when privatekey is not present.'
example: password123
privatekey:
type: string
description: 'The private key to sign the transaction, only needed if working with non-secure chaingateway wallet.'
example: '0x123456'
nonce:
type: string
description: 'The nonce for the transaction.'
example: '0x123456'
amount:
type: number
description: 'The amount of the ERC20 token to send.'
example: 100.0
required:
- from
- contractaddress
- to
- amount
/api/v2/polygon/transactions/erc721:
post:
summary: 'Create ERC721 transaction'
operationId: createERC721Transaction
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created'
data:
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created'
data:
type: object
properties:
txid:
type: string
example: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
401:
description: 'Wrong password'
content:
application/json:
schema:
type: object
example:
status: 401
ok: false
message: 'Wrong password provided'
errors: []
properties:
status:
type: integer
example: 401
ok:
type: boolean
example: false
message:
type: string
example: 'Wrong password provided'
errors:
type: array
example: []
422:
description: 'Insufficent funds'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors:
type: array
example: []
tags:
- 'Polygon Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
contractaddress:
type: string
description: 'The address of the ERC721 contract. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
tokenId:
type: integer
description: 'The token ID to send.'
example: 1
gas:
type: integer
description: 'The gas limit for the transaction.'
example: 21000
gasprice:
type: number
description: 'The gas price for the transaction.'
example: 1000000000.0
maxPriorityFeePerGas:
type: number
description: ''
example: 4326.41688
maxFeePerGas:
type: number
description: ''
example: 4326.41688
password:
type: string
description: 'This field is required when privatekey is not present.'
example: '|]|{+-'
privatekey:
type: string
description: ''
example: architecto
data:
type: string
description: ''
example: architecto
nonce:
type: string
description: ''
example: architecto
required:
- from
- contractaddress
- to
- tokenId
'/api/v2/polygon/erc20/{contract_address}':
get:
summary: 'Get ERC20 contract information'
operationId: getERC20ContractInformation
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'ERC20 contract fetched'
type: object
example:
status: 200
ok: true
message: 'ERC20 contract fetched'
data:
contractaddress: '0xdAC17F958D2ee523a2206206994597C13D831ec7'
decimals: 6
totalSupply: '51998658367.642960'
name: TetherUSD
symbol: USDT
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'ERC20 contract fetched'
data:
type: object
properties:
contractaddress:
type: string
example: '0xdAC17F958D2ee523a2206206994597C13D831ec7'
decimals:
type: integer
example: 6
totalSupply:
type: string
example: '51998658367.642960'
name:
type: string
example: TetherUSD
symbol:
type: string
example: USDT
-
description: ''
type: object
example:
status: success
data: data
properties:
status:
type: string
example: success
data:
type: string
example: data
tags:
- 'Polygon Blockchain Queries'
parameters:
-
in: path
name: contract_address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0xc2132D05D31c914a87C6611C10748AEb04B58e8F'
'/api/v2/polygon/transactions/{txid}/receipt/{decoded}':
get:
summary: 'Get receipt'
operationId: getReceipt
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: Decoded
type: object
example:
status: 200
ok: true
message: 'Succesfully parsedtransaction receipt'
data:
transaction:
blockHash: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber: '37701506'
cumulativeGasUsed: '627702'
effectiveGasPrice: '3.0000000000'
from: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed: '21000'
logs: []
logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status: true
to: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex: '8'
type: '8'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsedtransaction receipt'
data:
type: object
properties:
transaction:
type: object
properties:
blockHash:
type: string
example: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber:
type: string
example: '37701506'
cumulativeGasUsed:
type: string
example: '627702'
effectiveGasPrice:
type: string
example: '3.0000000000'
from:
type: string
example: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed:
type: string
example: '21000'
logs:
type: array
example: []
logsBloom:
type: string
example: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status:
type: boolean
example: true
to:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex:
type: string
example: '8'
type:
type: string
example: '8'
-
description: Encoded
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction receipt'
data:
transaction:
blockHash: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber: '0x23f4782'
contractAddress: null
cumulativeGasUsed: '0x993f6'
effectiveGasPrice: '0xb2d05e00'
from: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed: '0x5208'
logs: []
logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status: '0x1'
to: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex: '0x8'
type: '0x0'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction receipt'
data:
type: object
properties:
transaction:
type: object
properties:
blockHash:
type: string
example: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber:
type: string
example: '0x23f4782'
contractAddress:
type: string
example: null
cumulativeGasUsed:
type: string
example: '0x993f6'
effectiveGasPrice:
type: string
example: '0xb2d05e00'
from:
type: string
example: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed:
type: string
example: '0x5208'
logs:
type: array
example: []
logsBloom:
type: string
example: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status:
type: string
example: '0x1'
to:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex:
type: string
example: '0x8'
type:
type: string
example: '0x0'
422:
description: 'Transaction receipt not found'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'transaction not found'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'transaction not found'
errors:
type: array
example: []
tags:
- 'Polygon Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
-
in: path
name: decoded
description: "Optional parameter. If set to 'decoded' it will return the decoded transaction"
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: decoded
'/api/v2/polygon/addresses/export/{address}/privatekey':
post:
summary: ''
operationId: postApiV2PolygonAddressesExportAddressPrivatekey
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Private key exported'
data:
private_key: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Private key exported'
data:
type: object
properties:
private_key:
type: string
example: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- 'Polygon Addresses'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
parameters:
-
in: path
name: address
description: ''
example: architecto
required: true
schema:
type: string
/api/v2/polygon/gasprice:
get:
summary: 'Get Gas Price'
operationId: getGasPrice
description: 'This Method returns the gas price'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Gas price fetched'
content:
application/json:
schema:
type: object
example:
ok: true
status: 200
message: 'Successfully parsed'
data:
gasPrice: '12.28'
properties:
ok:
type: boolean
example: true
status:
type: integer
example: 200
message:
type: string
example: 'Successfully parsed'
data:
type: object
properties:
gasPrice:
type: string
example: '12.28'
tags:
- 'Polygon Blockchain Queries'
'/api/v2/polygon/nfts/{contract_address}/owner/{token_id}':
get:
summary: 'Get NFT Owner'
operationId: getNFTOwner
description: 'This Method returns the owner of an NFT'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'ERC721 owner fetched'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'ERC721 owner fetched'
data:
owner: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'ERC721 owner fetched'
data:
type: object
properties:
owner:
type: string
example: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
422:
description: 'Error! Could not get NFT owner'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Error! Could not get NFT owner'
error: 'Error message here'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Error! Could not get NFT owner'
error:
type: string
example: 'Error message here'
tags:
- 'Polygon Blockchain Queries'
parameters:
-
in: path
name: contract_address
description: 'The contract address'
example: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
required: true
schema:
type: string
-
in: path
name: token_id
description: 'The token id'
example: '1234'
required: true
schema:
type: string
'/api/v2/polygon/nfts/{contract_address}/uri/{token_id}':
get:
summary: 'Get NFT Token URI'
operationId: getNFTTokenURI
description: 'This Method returns the URI of an NFT token'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'NFT token URI fetched'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'NFT token URI fetched'
data:
tokenURI: 'https://api.opensea.io/api/v1/metadata/0x06012c8cf97bead5deae237070f9587f8e7a266d/1'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'NFT token URI fetched'
data:
type: object
properties:
tokenURI:
type: string
example: 'https://api.opensea.io/api/v1/metadata/0x06012c8cf97bead5deae237070f9587f8e7a266d/1'
422:
description: 'Error! Could not get NFT token URI'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Error! Could not get NFT token URI'
error: 'Error message here'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Error! Could not get NFT token URI'
error:
type: string
example: 'Error message here'
tags:
- 'Polygon Blockchain Queries'
parameters:
-
in: path
name: contract_address
description: 'The contract address'
example: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
required: true
schema:
type: string
-
in: path
name: token_id
description: 'The token id'
example: '1234'
required: true
schema:
type: string
/api/v2/polygon/webhooks:
get:
summary: 'Get all webhooks'
operationId: getAllWebhooks
description: 'Lists all webhooks created by the user.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Polygon Webhooks'
post:
summary: 'Create webhook'
operationId: createWebhook
description: 'Creates a new webhook for real-time communication and event notification.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Webhook created'
data:
webhook: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook created'
data:
type: object
properties:
webhook:
type: string
example: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
status: 422
ok: false
message: 'Data validation failed'
errors:
from:
- 'The from field format is invalid.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
from:
type: array
example:
- 'The from field format is invalid.'
items:
type: string
tags:
- 'Polygon Webhooks'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'Sender address (required if not "to"). This field is required when to is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
to:
type: string
description: 'Receiver address (required if not providing "from"). This field is required when from is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
url:
type: string
description: 'URL for webhook notifications (required). Must be a valid URL.'
example: 'http://vonrueden.com/'
contractaddress:
type: string
description: 'The Address of an Contract you want to track (Not allowwed on Bitcoin). This field is required when none of from and to are present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
token_id:
type: string
description: 'This field is required when none of from and to are present.'
example: null
type:
type: string
description: ''
example: ERC20
enum:
- MATIC
- ERC20
- ERC721
reference:
type: string
description: 'A reference for the webhook. Must not be greater than 255 characters.'
example: 'n'
nullable: true
required:
- url
'/api/v2/polygon/webhooks/{id}':
get:
summary: 'Get webhook'
operationId: getWebhook
description: 'Show the details of a Webhook'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Polygon Webhooks'
put:
summary: 'Update webhook'
operationId: updateWebhook
description: 'Updates an existing webhook with the provided data.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Webhook updated'
data:
id: 9b73d6ee-8a8b-44c3-b2c6-0bd1e1d8cd9a
from: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
to: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
contractaddress: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
type: BEP20
token_id: null
url: 'http://blanda.com/debitis-et-id-nisi-qui-id.html'
is_active: true
is_invalid: false
old_id: null
created_at: '2024-02-29T14:51:35.000000Z'
updated_at: '2024-02-29T14:52:33.000000Z'
deleted_at: null
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook updated'
data:
type: object
properties:
id:
type: string
example: 9b73d6ee-8a8b-44c3-b2c6-0bd1e1d8cd9a
from:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
to:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
contractaddress:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
type:
type: string
example: BEP20
token_id:
type: string
example: null
url:
type: string
example: 'http://blanda.com/debitis-et-id-nisi-qui-id.html'
is_active:
type: boolean
example: true
is_invalid:
type: boolean
example: false
old_id:
type: string
example: null
created_at:
type: string
example: '2024-02-29T14:51:35.000000Z'
updated_at:
type: string
example: '2024-02-29T14:52:33.000000Z'
deleted_at:
type: string
example: null
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: 404
ok: false
message: 'Webhook not found'
data: []
properties:
status:
type: integer
example: 404
ok:
type: boolean
example: false
message:
type: string
example: 'Webhook not found'
data:
type: array
example: []
tags:
- 'Polygon Webhooks'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'Sender address (required if not "to"). This field is required when to is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
to:
type: string
description: 'Receiver address (required if not providing "from"). This field is required when from is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
url:
type: string
description: 'URL for webhook notifications (required). Must be a valid URL.'
example: 'http://vonrueden.com/'
contractaddress:
type: string
description: 'The Address of an Contract you want to track (Not allowwed on Bitcoin). This field is required when none of from and to are present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
token_id:
type: string
description: 'This field is required when none of from and to are present.'
example: null
type:
type: string
description: ''
example: ERC20
enum:
- MATIC
- ERC20
- ERC721
reference:
type: string
description: 'A reference for the webhook. Must not be greater than 255 characters.'
example: 'n'
nullable: true
required:
- url
delete:
summary: 'Delete webhook'
operationId: deleteWebhook
description: 'This method will delete the specified webhook.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Webhook deleted'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook deleted'
data:
type: array
example: []
tags:
- 'Polygon Webhooks'
parameters:
-
in: path
name: id
description: 'The UUID of the webhook you want to show.'
example: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
required: true
schema:
type: string
/api/v2/polygon/webhooks/notifications:
get:
summary: 'Display all Webhook Notifications'
operationId: displayAllWebhookNotifications
description: 'Lists all webhook notifications created by the user for the specific Blockchain and Network'
parameters:
-
in: query
name: page
description: 'The page number to fetch'
example: 16
required: false
schema:
type: integer
description: 'The page number to fetch'
example: 16
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully fetched notifications'
current_page: 1
data:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
from: 1
last_page: 1
last_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications'
per_page: 15
prev_page_url: null
to: 1
total: 1
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully fetched notifications'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
items:
type: object
properties:
id:
type: string
example: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id:
type: string
example: 9ba897da-7651-4df6-80ef-11c898b195e5
txid:
type: string
example: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type:
type: string
example: TRC20
contractaddress:
type: string
example: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from:
type: string
example: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to:
type: string
example: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid:
type: string
example: null
amount:
type: string
example: null
blocknumber:
type: string
example: '19499380'
status:
type: string
example: failed
url:
type: string
example: 'https://example.com'
success:
type: boolean
example: false
attempts:
type: integer
example: 0
created_at:
type: string
example: '2024-05-05T19:33:52.000000Z'
updated_at:
type: string
example: '2024-05-05T19:33:54.000000Z'
network:
type: string
example: testnet
blockchain:
type: string
example: tron
response:
type: string
example: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications'
per_page:
type: integer
example: 15
prev_page_url:
type: string
example: null
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'Polygon Webhooks'
/api/v2/polygon/webhooks/notifications/failed:
get:
summary: 'Display all failed Webhook Notification'
operationId: displayAllFailedWebhookNotification
description: "Lists all failed webhook notifications created by the user for the specific Blockchain and Network\nBased on the response you can use our /webhooks/notifications/{id}/retry to retry every failed webhook.\n\nAfter you started the retry process, the webhook will be removed from this list. should the retry process fail, the webhook will be added back to this list."
parameters:
-
in: query
name: page
description: 'The page number to fetch'
example: 16
required: false
schema:
type: integer
description: 'The page number to fetch'
example: 16
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully fetched failed notifications'
current_page: 1
data:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
from: 1
last_page: 1
last_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed'
per_page: 15
prev_page_url: null
to: 1
total: 1
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully fetched failed notifications'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
items:
type: object
properties:
id:
type: string
example: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id:
type: string
example: 9ba897da-7651-4df6-80ef-11c898b195e5
txid:
type: string
example: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type:
type: string
example: TRC20
contractaddress:
type: string
example: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from:
type: string
example: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to:
type: string
example: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid:
type: string
example: null
amount:
type: string
example: null
blocknumber:
type: string
example: '19499380'
status:
type: string
example: failed
url:
type: string
example: 'https://example.com'
success:
type: boolean
example: false
attempts:
type: integer
example: 0
created_at:
type: string
example: '2024-05-05T19:33:52.000000Z'
updated_at:
type: string
example: '2024-05-05T19:33:54.000000Z'
network:
type: string
example: testnet
blockchain:
type: string
example: tron
response:
type: string
example: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed'
per_page:
type: integer
example: 15
prev_page_url:
type: string
example: null
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'Polygon Webhooks'
'/api/v2/polygon/webhooks/notifications/{id}/retry':
post:
summary: 'Retry a failed Webhook Notification'
operationId: retryAFailedWebhookNotification
description: 'Retries a failed webhook notification'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses: { }
tags:
- 'Polygon Webhooks'
parameters:
-
in: path
name: id
description: 'The ID of the notification.'
example: architecto
required: true
schema:
type: string
/api/v2/bitcoin/blocks/number:
get:
summary: 'Get latest block number'
operationId: getLatestBlockNumber
description: 'This Method returns the latest block number'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Bitcoin Blockchain Queries'
'/api/v2/bitcoin/blocks/{block_number}':
get:
summary: 'get block by number or hash'
operationId: getBlockByNumberOrHash
description: 'This Method returns the block by its number'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Bitcoin Blockchain Queries'
parameters:
-
in: path
name: block_number
description: 'The block number'
example: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
required: true
schema:
type: string
/api/v2/bitcoin/transactions:
get:
summary: 'List all transaction created by Chaingateway'
operationId: listAllTransactionCreatedByChaingateway
description: 'Lists all transactions created by our api. Please note that this will only list transactions created by our api as wo currently do not offer an transaction index.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transactions'
current_page: 1
data:
-
id: 25
user_id: 1
blockchain: bitcoin
network: testnet
type: default
txid: 90b769cc7671f12849d61a5406aef65f0f10f289a27765f46f9d451c9a96a760
from: 7b75AzvQirurCilyLxGpE0IHf9LVEk
to: tb1qzrmcwlnjclrwr6m3g8863n4zl8hkm0cjfnhzmj
contractaddress: null
amount: '0.000010000000'
tokenid: null
responseJson: '{"result":"90b769cc7671f12849d61a5406aef65f0f10f289a27765f46f9d451c9a96a760","error":null,"id":1}'
httpStatus: '201'
created_at: '2024-02-29T11:30:19.000000Z'
updated_at: '2024-02-29T11:30:19.000000Z'
first_page_url: 'http://testnet.chaingateway.test:81/api/v2/bitcoin/transactions?page=1'
from: 1
last_page: 1
last_page_url: 'http://testnet.chaingateway.test:81/api/v2/bitcoin/transactions?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://testnet.chaingateway.test:81/api/v2/bitcoin/transactions?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://testnet.chaingateway.test:81/api/v2/bitcoin/transactions'
per_page: 15
prev_page_url: null
to: 1
total: 1
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transactions'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 25
user_id: 1
blockchain: bitcoin
network: testnet
type: default
txid: 90b769cc7671f12849d61a5406aef65f0f10f289a27765f46f9d451c9a96a760
from: 7b75AzvQirurCilyLxGpE0IHf9LVEk
to: tb1qzrmcwlnjclrwr6m3g8863n4zl8hkm0cjfnhzmj
contractaddress: null
amount: '0.000010000000'
tokenid: null
responseJson: '{"result":"90b769cc7671f12849d61a5406aef65f0f10f289a27765f46f9d451c9a96a760","error":null,"id":1}'
httpStatus: '201'
created_at: '2024-02-29T11:30:19.000000Z'
updated_at: '2024-02-29T11:30:19.000000Z'
items:
type: object
properties:
id:
type: integer
example: 25
user_id:
type: integer
example: 1
blockchain:
type: string
example: bitcoin
network:
type: string
example: testnet
type:
type: string
example: default
txid:
type: string
example: 90b769cc7671f12849d61a5406aef65f0f10f289a27765f46f9d451c9a96a760
from:
type: string
example: 7b75AzvQirurCilyLxGpE0IHf9LVEk
to:
type: string
example: tb1qzrmcwlnjclrwr6m3g8863n4zl8hkm0cjfnhzmj
contractaddress:
type: string
example: null
amount:
type: string
example: '0.000010000000'
tokenid:
type: string
example: null
responseJson:
type: string
example: '{"result":"90b769cc7671f12849d61a5406aef65f0f10f289a27765f46f9d451c9a96a760","error":null,"id":1}'
httpStatus:
type: string
example: '201'
created_at:
type: string
example: '2024-02-29T11:30:19.000000Z'
updated_at:
type: string
example: '2024-02-29T11:30:19.000000Z'
first_page_url:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bitcoin/transactions?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bitcoin/transactions?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://testnet.chaingateway.test:81/api/v2/bitcoin/transactions?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bitcoin/transactions'
per_page:
type: integer
example: 15
prev_page_url:
type: string
example: null
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'Bitcoin Transactions'
post:
summary: 'Create Bitcoin Transaction'
operationId: createBitcoinTransaction
description: 'Create a new Bitcoin transaction'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Transaction created'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created transaction'
data:
txid: 9aede7eee01b79aab1cd5a8990f31069756bdf9c969c67b1fd90428ece11919f
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created transaction'
data:
type: object
properties:
txid:
type: string
example: 9aede7eee01b79aab1cd5a8990f31069756bdf9c969c67b1fd90428ece11919f
422:
description: 'Wrong password'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Error: The wallet passphrase entered was incorrect.'
data: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Error: The wallet passphrase entered was incorrect.'
data:
type: array
example: []
tags:
- 'Bitcoin Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^(bc1|tb1|[13])[a-zA-HJ-NP-Z0-9]{25,39}$/.'
example: bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq
amount:
type: number
description: 'The amount to send.'
example: 0.0001
walletname:
type: string
description: 'The name of the wallet to send the transaction from.'
example: mywallet
password:
type: string
description: 'The password to unlock the wallet.'
example: mypassword
subtractfee:
type: boolean
description: 'Whether to subtract the fee from the amount being sent.'
example: true
speed:
type: string
description: 'The speed of the transaction.'
example: fast
enum:
- fast
- medium
- slow
required:
- to
- amount
- walletname
- password
- speed
'/api/v2/bitcoin/transactions/{txid}':
get:
summary: 'Show a transaction'
operationId: showATransaction
description: 'Show the details of a transaction'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: Encoded
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction'
data:
txid: 020000000001019f9111ce8e4290fdb1679c969cdf6b756910f390895acdb1aa791be0eee7ed9a0100000000feffffff02e80300000000000016001410f7877e72c7c6e1eb7141cfa8cea2f9ef6dbf1245e5000000000000160014846e43c02307cc2dc380029de9383db83117ab020247304402200a1931a70bbd9b5490d667858389f9be81528c2fba379b2e44e599b18fce98810220147eb331d461386b1cb5155b398b2b8a3da86fcb1db933871c48b41bdd12815d012103fc7450a4f530a3e14d0511064dd3f975737ec510c60e456f85796863de997015de5d2700
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction'
data:
type: object
properties:
txid:
type: string
example: 020000000001019f9111ce8e4290fdb1679c969cdf6b756910f390895acdb1aa791be0eee7ed9a0100000000feffffff02e80300000000000016001410f7877e72c7c6e1eb7141cfa8cea2f9ef6dbf1245e5000000000000160014846e43c02307cc2dc380029de9383db83117ab020247304402200a1931a70bbd9b5490d667858389f9be81528c2fba379b2e44e599b18fce98810220147eb331d461386b1cb5155b398b2b8a3da86fcb1db933871c48b41bdd12815d012103fc7450a4f530a3e14d0511064dd3f975737ec510c60e456f85796863de997015de5d2700
422:
description: 'Transaction not found'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'No such mempool or blockchain transaction. Use gettransaction for wallet transactions.'
data: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'No such mempool or blockchain transaction. Use gettransaction for wallet transactions.'
data:
type: array
example: []
tags:
- 'Bitcoin Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction id of the transaction'
example: architecto
required: true
schema:
type: string
'/api/v2/bitcoin/transactions/{txid}/decoded':
get:
summary: 'Show a decoded transaction'
operationId: showADecodedTransaction
description: 'Show the details of a decoded transaction'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: decoded
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction'
data:
txid:
txid: 90b769cc7671f12849d61a5406aef65f0f10f289a27765f46f9d451c9a96a760
hash: 485f16d811c52219bec93ae97fa55a25e64509dddbe93b1b658c8aa4c039cab8
version: 2
size: 222
vsize: 141
weight: 561
locktime: 2579934
vin:
-
txid: 9aede7eee01b79aab1cd5a8990f31069756bdf9c969c67b1fd90428ece11919f
vout: 1
scriptSig:
asm: ''
hex: ''
txinwitness:
- 304402200a1931a70bbd9b5490d667858389f9be81528c2fba379b2e44e599b18fce98810220147eb331d461386b1cb5155b398b2b8a3da86fcb1db933871c48b41bdd12815d01
- 03fc7450a4f530a3e14d0511064dd3f975737ec510c60e456f85796863de997015
sequence: 4294967294
vout:
-
value: 1.0E-5
'n': 0
scriptPubKey:
asm: '0 10f7877e72c7c6e1eb7141cfa8cea2f9ef6dbf12'
desc: 'addr(tb1qzrmcwlnjclrwr6m3g8863n4zl8hkm0cjfnhzmj)#5x2eym78'
hex: 001410f7877e72c7c6e1eb7141cfa8cea2f9ef6dbf12
address: tb1qzrmcwlnjclrwr6m3g8863n4zl8hkm0cjfnhzmj
type: witness_v0_keyhash
-
value: 0.00058693
'n': 1
scriptPubKey:
asm: '0 846e43c02307cc2dc380029de9383db83117ab02'
desc: 'addr(tb1qs3hy8sprqlxzmsuqq2w7jwpahqc302czvsfcf3)#v68w73al'
hex: 0014846e43c02307cc2dc380029de9383db83117ab02
address: tb1qs3hy8sprqlxzmsuqq2w7jwpahqc302czvsfcf3
type: witness_v0_keyhash
hex: 020000000001019f9111ce8e4290fdb1679c969cdf6b756910f390895acdb1aa791be0eee7ed9a0100000000feffffff02e80300000000000016001410f7877e72c7c6e1eb7141cfa8cea2f9ef6dbf1245e5000000000000160014846e43c02307cc2dc380029de9383db83117ab020247304402200a1931a70bbd9b5490d667858389f9be81528c2fba379b2e44e599b18fce98810220147eb331d461386b1cb5155b398b2b8a3da86fcb1db933871c48b41bdd12815d012103fc7450a4f530a3e14d0511064dd3f975737ec510c60e456f85796863de997015de5d2700
blockhash: 000000000000000d3883204a9223ee2f551421f8a2a658bc9b929108c1fffa13
confirmations: 8
time: 1709206378
blocktime: 1709206378
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction'
data:
type: object
properties:
txid:
type: object
properties:
txid:
type: string
example: 90b769cc7671f12849d61a5406aef65f0f10f289a27765f46f9d451c9a96a760
hash:
type: string
example: 485f16d811c52219bec93ae97fa55a25e64509dddbe93b1b658c8aa4c039cab8
version:
type: integer
example: 2
size:
type: integer
example: 222
vsize:
type: integer
example: 141
weight:
type: integer
example: 561
locktime:
type: integer
example: 2579934
vin:
type: array
example:
-
txid: 9aede7eee01b79aab1cd5a8990f31069756bdf9c969c67b1fd90428ece11919f
vout: 1
scriptSig:
asm: ''
hex: ''
txinwitness:
- 304402200a1931a70bbd9b5490d667858389f9be81528c2fba379b2e44e599b18fce98810220147eb331d461386b1cb5155b398b2b8a3da86fcb1db933871c48b41bdd12815d01
- 03fc7450a4f530a3e14d0511064dd3f975737ec510c60e456f85796863de997015
sequence: 4294967294
items:
type: object
properties:
txid:
type: string
example: 9aede7eee01b79aab1cd5a8990f31069756bdf9c969c67b1fd90428ece11919f
vout:
type: integer
example: 1
scriptSig:
type: object
properties:
asm:
type: string
example: ''
hex:
type: string
example: ''
txinwitness:
type: array
example:
- 304402200a1931a70bbd9b5490d667858389f9be81528c2fba379b2e44e599b18fce98810220147eb331d461386b1cb5155b398b2b8a3da86fcb1db933871c48b41bdd12815d01
- 03fc7450a4f530a3e14d0511064dd3f975737ec510c60e456f85796863de997015
items:
type: string
sequence:
type: integer
example: 4294967294
vout:
type: array
example:
-
value: 1.0E-5
'n': 0
scriptPubKey:
asm: '0 10f7877e72c7c6e1eb7141cfa8cea2f9ef6dbf12'
desc: 'addr(tb1qzrmcwlnjclrwr6m3g8863n4zl8hkm0cjfnhzmj)#5x2eym78'
hex: 001410f7877e72c7c6e1eb7141cfa8cea2f9ef6dbf12
address: tb1qzrmcwlnjclrwr6m3g8863n4zl8hkm0cjfnhzmj
type: witness_v0_keyhash
-
value: 0.00058693
'n': 1
scriptPubKey:
asm: '0 846e43c02307cc2dc380029de9383db83117ab02'
desc: 'addr(tb1qs3hy8sprqlxzmsuqq2w7jwpahqc302czvsfcf3)#v68w73al'
hex: 0014846e43c02307cc2dc380029de9383db83117ab02
address: tb1qs3hy8sprqlxzmsuqq2w7jwpahqc302czvsfcf3
type: witness_v0_keyhash
items:
type: object
properties:
value:
type: number
example: 1.0E-5
'n':
type: integer
example: 0
scriptPubKey:
type: object
properties:
asm:
type: string
example: '0 10f7877e72c7c6e1eb7141cfa8cea2f9ef6dbf12'
desc:
type: string
example: 'addr(tb1qzrmcwlnjclrwr6m3g8863n4zl8hkm0cjfnhzmj)#5x2eym78'
hex:
type: string
example: 001410f7877e72c7c6e1eb7141cfa8cea2f9ef6dbf12
address:
type: string
example: tb1qzrmcwlnjclrwr6m3g8863n4zl8hkm0cjfnhzmj
type:
type: string
example: witness_v0_keyhash
hex:
type: string
example: 020000000001019f9111ce8e4290fdb1679c969cdf6b756910f390895acdb1aa791be0eee7ed9a0100000000feffffff02e80300000000000016001410f7877e72c7c6e1eb7141cfa8cea2f9ef6dbf1245e5000000000000160014846e43c02307cc2dc380029de9383db83117ab020247304402200a1931a70bbd9b5490d667858389f9be81528c2fba379b2e44e599b18fce98810220147eb331d461386b1cb5155b398b2b8a3da86fcb1db933871c48b41bdd12815d012103fc7450a4f530a3e14d0511064dd3f975737ec510c60e456f85796863de997015de5d2700
blockhash:
type: string
example: 000000000000000d3883204a9223ee2f551421f8a2a658bc9b929108c1fffa13
confirmations:
type: integer
example: 8
time:
type: integer
example: 1709206378
blocktime:
type: integer
example: 1709206378
tags:
- 'Bitcoin Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction id of the transaction'
example: architecto
required: true
schema:
type: string
/api/v2/bitcoin/wallets:
get:
summary: 'Display all addresses'
operationId: displayAllAddresses
description: 'Lists all addresses you have created but not yet deleted'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed wallets'
data:
wallets:
- 01HP6FVARVTQES6WW8QHC5WHPT
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed wallets'
data:
type: object
properties:
wallets:
type: array
example:
- 01HP6FVARVTQES6WW8QHC5WHPT
items:
type: string
tags:
- 'Bitcoin Wallets'
post:
summary: 'Create a new Wallet'
operationId: createANewWallet
description: "This method will create a new wallet for you.\nThe wallet will be stored in our database and you can access it with the wallet name.\nThe wallet will be encrypted with the password you provide.\n\nafter creating the wallet, you can create several addresses for the wallet. There is no need to create a new wallet for each address.\n\n"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Address created'
data:
bitcoinwallet: 01HP6FVARVTQES6WW8QHC5WHPT
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Address created'
data:
type: object
properties:
bitcoinwallet:
type: string
example: 01HP6FVARVTQES6WW8QHC5WHPT
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Your address limit exceeded. Please upgrade your plan'
data: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Your address limit exceeded. Please upgrade your plan'
data:
type: array
example: []
tags:
- 'Bitcoin Wallets'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
'/api/v2/bitcoin/wallets/{wallet}':
get:
summary: 'Show Wallet details'
operationId: showWalletDetails
description: 'This method will return the wallet details.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Wallet fetched successfully'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Wallet fetched successfully'
data:
address: bc1qzq8m9ukvvgvj7kmlejnfr2q4ndmk2e4ndtr9rn
balance: 0
transactions: 0
unconfirmed: 0
label: 'My Wallet'
created_at: '2022-12-26T12:55:48.128000860Z'
updated_at: '2022-12-26T12:55:48.128000860Z'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Wallet fetched successfully'
data:
type: object
properties:
address:
type: string
example: bc1qzq8m9ukvvgvj7kmlejnfr2q4ndmk2e4ndtr9rn
balance:
type: integer
example: 0
transactions:
type: integer
example: 0
unconfirmed:
type: integer
example: 0
label:
type: string
example: 'My Wallet'
created_at:
type: string
example: '2022-12-26T12:55:48.128000860Z'
updated_at:
type: string
example: '2022-12-26T12:55:48.128000860Z'
tags:
- 'Bitcoin Wallets'
delete:
summary: 'Delete an address'
operationId: deleteAnAddress
description: 'This method will delete your address. This decreases your used address metrics'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Address deleted'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Address deleted'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Address deleted'
data:
type: array
example: []
tags:
- 'Bitcoin Wallets'
parameters:
-
in: path
name: wallet
description: 'The address you want to fetch.'
example: bc1qzq8m9ukvvgvj7kmlejnfr2q4ndmk2e4ndtr9rn
required: true
schema:
type: string
'/api/v2/bitcoin/wallets/{wallet}/addresses':
get:
summary: 'Get wallet addresses'
operationId: getWalletAddresses
description: 'This method will return all addresses of a wallet'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Address created'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Address created'
data:
address: bc1qzq8m9ukvvgvj7kmlejnfr2q4ndmk2e4ndtr9rn
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Address created'
data:
type: object
properties:
address:
type: string
example: bc1qzq8m9ukvvgvj7kmlejnfr2q4ndmk2e4ndtr9rn
tags:
- 'Bitcoin Wallets'
post:
summary: 'Create a new wallet address'
operationId: createANewWalletAddress
description: 'This method will create a new address. This decreases your used address metrics'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Address created'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Address created'
data:
address: bc1qzq8m9ukvvgvj7kmlejnfr2q4ndmk2e4ndtr9rn
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Address created'
data:
type: object
properties:
address:
type: string
example: bc1qzq8m9ukvvgvj7kmlejnfr2q4ndmk2e4ndtr9rn
tags:
- 'Bitcoin Wallets'
parameters:
-
in: path
name: wallet
description: 'The wallet you want to get the addresses from.'
example: 7b75AzvQirurCilyLxGpE0IHf9LVEk
required: true
schema:
type: string
'/api/v2/bitcoin/wallets/{wallet}/addresses/{address}/export':
post:
summary: 'Export Privatekey of an Address'
operationId: exportPrivatekeyOfAnAddress
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Address exportet'
data: bedd8c2ffbe3dea6fd4b8fd7dcfada3f9fbbc9de
'0': 200
'1': 'Address exportet'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Address exportet'
data:
type: string
example: bedd8c2ffbe3dea6fd4b8fd7dcfada3f9fbbc9de
0:
type: integer
example: 200
1:
type: string
example: 'Address exportet'
401:
description: 'Wrong Password'
content:
application/json:
schema:
type: object
example:
status: 401
ok: false
message: 'Wrong Password'
data: []
properties:
status:
type: integer
example: 401
ok:
type: boolean
example: false
message:
type: string
example: 'Wrong Password'
data:
type: array
example: []
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Address not found'
type: object
example:
status: 422
ok: false
message: 'Address not found'
data: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Address not found'
data:
type: array
example: []
-
description: 'Address not ready for Export. Please try again in 2 minutes.'
type: object
example:
status: 422
ok: false
message: 'Address not ready for Export. Please try again in 2 minutes.'
data: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Address not ready for Export. Please try again in 2 minutes.'
data:
type: array
example: []
tags:
- 'Bitcoin Wallets'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
parameters:
-
in: path
name: wallet
description: 'The address you want to export.'
example: 01HP6FVARVTQES6WW8QHC5WHPT
required: true
schema:
type: string
-
in: path
name: address
description: 'The address you want to export.'
example: 1bc1qzq8m9ukvvgvj7kmlejnfr2q4ndmk2e4ndtr9rn
required: true
schema:
type: string
/api/v2/bitcoin/webhooks:
get:
summary: 'Display all webhooks'
operationId: displayAllWebhooks
description: 'Lists all webhooks created by the user.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"status\": 200,\n \"ok\": true,\n \"message\": \"Successfully parsed webhooks\",\n \"data\": {\n \"ipns\": [\n {\n \"id\": \"9b2b4dcc-1479-4bcd-9b8a-015673e80f46\",\n \"from\": \"bc1qmexahpjpyrzjahy6j4gpqhwnglkff5urmzus6wv6pvd2lsn7jlwqka7r9d\",\n \"to\": null,\n \"url\": \"https://example.com/webhook\",\n \"is_active\": true,\n \"created_at\": \"2024-01-25T12:00:00.000000Z\",\n \"updated_at\": \"2024-01-25T12:00:00.000000Z\"\n },\n ...\n ]\n }\n}"
tags:
- 'Bitcoin Webhooks'
post:
summary: 'Create a new Webhook'
operationId: createANewWebhook
description: 'Creates a new webhook for real-time communication and event notification.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Webhook created'
data:
webhook: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook created'
data:
type: object
properties:
webhook:
type: string
example: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
status: 422
ok: false
message: 'Data validation failed'
errors:
from:
- 'The from field format is invalid.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
from:
type: array
example:
- 'The from field format is invalid.'
items:
type: string
tags:
- 'Bitcoin Webhooks'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'Sender address (required if not providing type, to, contractaddress, and tokenid). This field is required when none of type, to, contractaddress, and tokenid are present.'
example: null
to:
type: string
description: 'Receiver address (required if not providing type, from, contractaddress, and tokenid). This field is required when none of from, type, contractaddress, and tokenid are present.'
example: null
url:
type: string
description: 'URL for webhook notifications (required).'
example: 'http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html'
required:
- url
'/api/v2/bitcoin/webhooks/{id}':
get:
summary: 'Display a webhook'
operationId: displayAWebhook
description: 'Show the details of a Webhook'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Bitcoin Webhooks'
put:
summary: 'Update a Webhook'
operationId: updateAWebhook
description: 'Updates an existing webhook with the provided data.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Webhook updated'
data:
id: 9b73d6ee-8a8b-44c3-b2c6-0bd1e1d8cd9a
from: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
to: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
contractaddress: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
type: BEP20
token_id: null
url: 'http://blanda.com/debitis-et-id-nisi-qui-id.html'
is_active: true
is_invalid: false
old_id: null
created_at: '2024-02-29T14:51:35.000000Z'
updated_at: '2024-02-29T14:52:33.000000Z'
deleted_at: null
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook updated'
data:
type: object
properties:
id:
type: string
example: 9b73d6ee-8a8b-44c3-b2c6-0bd1e1d8cd9a
from:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
to:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
contractaddress:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
type:
type: string
example: BEP20
token_id:
type: string
example: null
url:
type: string
example: 'http://blanda.com/debitis-et-id-nisi-qui-id.html'
is_active:
type: boolean
example: true
is_invalid:
type: boolean
example: false
old_id:
type: string
example: null
created_at:
type: string
example: '2024-02-29T14:51:35.000000Z'
updated_at:
type: string
example: '2024-02-29T14:52:33.000000Z'
deleted_at:
type: string
example: null
tags:
- 'Bitcoin Webhooks'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'Sender address (required if not providing type, to, contractaddress, and tokenid). This field is required when none of type, to, contractaddress, and tokenid are present.'
example: null
to:
type: string
description: 'Receiver address (required if not providing type, from, contractaddress, and tokenid). This field is required when none of from, type, contractaddress, and tokenid are present.'
example: null
url:
type: string
description: 'URL for webhook notifications (required).'
example: 'http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html'
required:
- url
delete:
summary: 'Delete a Webhook'
operationId: deleteAWebhook
description: 'This method will delete the specified webhook.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Webhook deleted'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook deleted'
data:
type: array
example: []
tags:
- 'Bitcoin Webhooks'
parameters:
-
in: path
name: id
description: 'The UUID of the webhook you want to show.'
example: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
required: true
schema:
type: string
/api/v2/bitcoin/webhooks/notifications:
get:
summary: 'Display all Webhook Notifications'
operationId: displayAllWebhookNotifications
description: 'Lists all webhook notifications created by the user for the specific Blockchain and Network'
parameters:
-
in: query
name: page
description: 'The page number to fetch'
example: 16
required: false
schema:
type: integer
description: 'The page number to fetch'
example: 16
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully fetched notifications'
current_page: 1
data:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
from: 1
last_page: 1
last_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications'
per_page: 15
prev_page_url: null
to: 1
total: 1
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully fetched notifications'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
items:
type: object
properties:
id:
type: string
example: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id:
type: string
example: 9ba897da-7651-4df6-80ef-11c898b195e5
txid:
type: string
example: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type:
type: string
example: TRC20
contractaddress:
type: string
example: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from:
type: string
example: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to:
type: string
example: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid:
type: string
example: null
amount:
type: string
example: null
blocknumber:
type: string
example: '19499380'
status:
type: string
example: failed
url:
type: string
example: 'https://example.com'
success:
type: boolean
example: false
attempts:
type: integer
example: 0
created_at:
type: string
example: '2024-05-05T19:33:52.000000Z'
updated_at:
type: string
example: '2024-05-05T19:33:54.000000Z'
network:
type: string
example: testnet
blockchain:
type: string
example: tron
response:
type: string
example: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications'
per_page:
type: integer
example: 15
prev_page_url:
type: string
example: null
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'Bitcoin Webhooks'
/api/v2/bitcoin/webhooks/notifications/failed:
get:
summary: 'Display all failed Webhook Notification'
operationId: displayAllFailedWebhookNotification
description: "Lists all failed webhook notifications created by the user for the specific Blockchain and Network\nBased on the response you can use our /webhooks/notifications/{id}/retry to retry every failed webhook.\n\nAfter you started the retry process, the webhook will be removed from this list. should the retry process fail, the webhook will be added back to this list."
parameters:
-
in: query
name: page
description: 'The page number to fetch'
example: 16
required: false
schema:
type: integer
description: 'The page number to fetch'
example: 16
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully fetched failed notifications'
current_page: 1
data:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
from: 1
last_page: 1
last_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed'
per_page: 15
prev_page_url: null
to: 1
total: 1
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully fetched failed notifications'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
items:
type: object
properties:
id:
type: string
example: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id:
type: string
example: 9ba897da-7651-4df6-80ef-11c898b195e5
txid:
type: string
example: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type:
type: string
example: TRC20
contractaddress:
type: string
example: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from:
type: string
example: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to:
type: string
example: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid:
type: string
example: null
amount:
type: string
example: null
blocknumber:
type: string
example: '19499380'
status:
type: string
example: failed
url:
type: string
example: 'https://example.com'
success:
type: boolean
example: false
attempts:
type: integer
example: 0
created_at:
type: string
example: '2024-05-05T19:33:52.000000Z'
updated_at:
type: string
example: '2024-05-05T19:33:54.000000Z'
network:
type: string
example: testnet
blockchain:
type: string
example: tron
response:
type: string
example: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed'
per_page:
type: integer
example: 15
prev_page_url:
type: string
example: null
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'Bitcoin Webhooks'
'/api/v2/bitcoin/webhooks/notifications/{id}/retry':
post:
summary: 'Retry a failed Webhook Notification'
operationId: retryAFailedWebhookNotification
description: 'Retries a failed webhook notification'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses: { }
tags:
- 'Bitcoin Webhooks'
parameters:
-
in: path
name: id
description: 'The ID of the notification.'
example: architecto
required: true
schema:
type: string
/api/v2/arbitrum/blocks/number:
get:
summary: 'Get latest block number'
operationId: getLatestBlockNumber
description: 'This Method returns the latest block number'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Latest block number fetched'
type: object
example:
status: 200
ok: true
message: 'Latest block number fetched'
data:
blocknumber: 123456
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Latest block number fetched'
data:
type: object
properties:
blocknumber:
type: integer
example: 123456
-
description: ''
type: object
example:
status: 200
ok: true
message: 'Latest block number fetched'
data: 19151363
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Latest block number fetched'
data:
type: integer
example: 19151363
tags:
- 'Arbitrum Blockchain Queries'
'/api/v2/arbitrum/blocks/{block_number}':
get:
summary: 'Get block by number or hash'
operationId: getBlockByNumberOrHash
description: 'This Method returns the block by its number'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Block fetched'
type: object
example:
status: 200
ok: true
message: 'Block fetched'
data:
difficulty: 16
extraData: '0xd482020a83626f7286676f312e3137856c696e75780000000000000000000000fb14f09854175ad6379c2fce286a474ba103fe8270c97ab4ce4a89949c00c54a1b38740f620ab9b66e0991804d4adc2c85baba80efc3a802aec73d8f2a2bd88600'
gasLimit: 20836455
gasUsed: '0xdc0281'
hash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
logsBloom: '0x0b759230fd529cda05e9663e8cd2f1a5c4b9b92cece1108b0a7391043fa15d44f89f59a86c6674183a5392d0a35d6405d1f48edb3a4aa428a01ac5ed02eea24d1415580c028451b5d871ca4b9ea14db59c32c64a25d43d0781137d5ea23dae24540ee29fa305a28818a8125b06c08d7c0944c460958d4e09bce2497003cf53b21121ffc2cc8922cb54953f0839834f2c968367b94a369bf8d22beccf40a03216facc84a11687df580810e0e2219871a97253a0231b262010009ca148390c11759b10064ffece08511de701bca853adf6dc60c049d4a9a01a00f9fe8fa302e385415248ff66840241e094908201a181048f1420a92ac90e41080c4fa10918599c'
miner: '0x0000000000000000000000000000000000000000'
mixHash: '0x0000000000000000000000000000000000000000000000000000000000000000'
nonce: '0x0000000000000000'
number: 21785493
parentHash: '0x8cacb1ad30d3623f3ed01eb4a6b8990de88a50a4c9c3380ee0f3bb63cfd290ce'
receiptsRoot: '0x8507f82a9c3fe4dc02d8ca6bd332c06db723cd9f3148bf65ed81b5ab2533db11'
sha3Uncles: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347'
size: 60687
stateRoot: '0x1e428a1eacaec62d26c2e410d76baf66ae7f598f3cee8eda5c0e94656576426f'
timestamp: '2021-11-25 13:19:46'
totalDifficulty: 261320853
transactions:
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0xe898563caf3b8ed945bd23e9f1a5eca1f395180e'
gas: '0x203c76'
gasPrice: '0x53d1ac1000'
hash: '0xd664519ee6a2bab1031da8e56f814d9626878de9aedef2426a5356d572280f97'
input: '0x38ed1739000000000000000000000000000000000000000000000000193e8f3326c4db0000000000000000000000000000000000000000000000000000b9a333dce606c800000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000e898563caf3b8ed945bd23e9f1a5eca1f395180e00000000000000000000000000000000000000000000000000000000619f915700000000000000000000000000000000000000000000000000000000000000020000000000000000000000002c89bbc92bd86f8075d1decc58c7f4e0107f286b0000000000000000000000007ceb23fd6bc0add59e62ac25578270cff1b9f619'
nonce: '0x168ac'
to: '0x1b02da8cb0d097eb8d57a175b88c7d8b47997506'
transactionIndex: '0x0'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x136'
r: '0xa1ac2567f13ba553713d4f21db8eb3617c04d51d7ed81964516aac8142528f52'
s: '0x11ac82d2353d6441f6bf1e182fbfae73b315461d1283f8048098311aac699b6f'
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0x41bf9148a378a12f0bf5d0ae050f2b72fd8fc290'
gas: '0x9aeb'
gasPrice: '0x14f46b0400'
hash: '0x65c649006ca5b5812d27b141b7620c884bdcf0b55872e2c879ce7e119bb92e40'
input: '0x2e1a7d4d00000000000000000000000000000000000000000000000d8d726b7177a80000'
nonce: '0xd'
to: '0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270'
transactionIndex: '0xe'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x135'
r: '0xac00b4880ad2d11d8443aca6e2b097e491fb5fe48466de30d12655b882d3b85f'
s: '0x377d1b9bb9bfbc3d565f34910240bd2cb81791dcf2016d07e595f1ada2c7ce15'
-
- '... More transactions here'
transactionsRoot: '0xdbab0c76f6a233225148be047c007572ffd7bd49b08d4da30c0a32fb5ae1ae02'
uncles: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Block fetched'
data:
type: object
properties:
difficulty:
type: integer
example: 16
extraData:
type: string
example: '0xd482020a83626f7286676f312e3137856c696e75780000000000000000000000fb14f09854175ad6379c2fce286a474ba103fe8270c97ab4ce4a89949c00c54a1b38740f620ab9b66e0991804d4adc2c85baba80efc3a802aec73d8f2a2bd88600'
gasLimit:
type: integer
example: 20836455
gasUsed:
type: string
example: '0xdc0281'
hash:
type: string
example: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
logsBloom:
type: string
example: '0x0b759230fd529cda05e9663e8cd2f1a5c4b9b92cece1108b0a7391043fa15d44f89f59a86c6674183a5392d0a35d6405d1f48edb3a4aa428a01ac5ed02eea24d1415580c028451b5d871ca4b9ea14db59c32c64a25d43d0781137d5ea23dae24540ee29fa305a28818a8125b06c08d7c0944c460958d4e09bce2497003cf53b21121ffc2cc8922cb54953f0839834f2c968367b94a369bf8d22beccf40a03216facc84a11687df580810e0e2219871a97253a0231b262010009ca148390c11759b10064ffece08511de701bca853adf6dc60c049d4a9a01a00f9fe8fa302e385415248ff66840241e094908201a181048f1420a92ac90e41080c4fa10918599c'
miner:
type: string
example: '0x0000000000000000000000000000000000000000'
mixHash:
type: string
example: '0x0000000000000000000000000000000000000000000000000000000000000000'
nonce:
type: string
example: '0x0000000000000000'
number:
type: integer
example: 21785493
parentHash:
type: string
example: '0x8cacb1ad30d3623f3ed01eb4a6b8990de88a50a4c9c3380ee0f3bb63cfd290ce'
receiptsRoot:
type: string
example: '0x8507f82a9c3fe4dc02d8ca6bd332c06db723cd9f3148bf65ed81b5ab2533db11'
sha3Uncles:
type: string
example: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347'
size:
type: integer
example: 60687
stateRoot:
type: string
example: '0x1e428a1eacaec62d26c2e410d76baf66ae7f598f3cee8eda5c0e94656576426f'
timestamp:
type: string
example: '2021-11-25 13:19:46'
totalDifficulty:
type: integer
example: 261320853
transactions:
type: array
example:
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0xe898563caf3b8ed945bd23e9f1a5eca1f395180e'
gas: '0x203c76'
gasPrice: '0x53d1ac1000'
hash: '0xd664519ee6a2bab1031da8e56f814d9626878de9aedef2426a5356d572280f97'
input: '0x38ed1739000000000000000000000000000000000000000000000000193e8f3326c4db0000000000000000000000000000000000000000000000000000b9a333dce606c800000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000e898563caf3b8ed945bd23e9f1a5eca1f395180e00000000000000000000000000000000000000000000000000000000619f915700000000000000000000000000000000000000000000000000000000000000020000000000000000000000002c89bbc92bd86f8075d1decc58c7f4e0107f286b0000000000000000000000007ceb23fd6bc0add59e62ac25578270cff1b9f619'
nonce: '0x168ac'
to: '0x1b02da8cb0d097eb8d57a175b88c7d8b47997506'
transactionIndex: '0x0'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x136'
r: '0xa1ac2567f13ba553713d4f21db8eb3617c04d51d7ed81964516aac8142528f52'
s: '0x11ac82d2353d6441f6bf1e182fbfae73b315461d1283f8048098311aac699b6f'
-
blockHash: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber: '0x14c6b95'
from: '0x41bf9148a378a12f0bf5d0ae050f2b72fd8fc290'
gas: '0x9aeb'
gasPrice: '0x14f46b0400'
hash: '0x65c649006ca5b5812d27b141b7620c884bdcf0b55872e2c879ce7e119bb92e40'
input: '0x2e1a7d4d00000000000000000000000000000000000000000000000d8d726b7177a80000'
nonce: '0xd'
to: '0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270'
transactionIndex: '0xe'
value: '0x0'
type: '0x0'
chainId: '0x89'
v: '0x135'
r: '0xac00b4880ad2d11d8443aca6e2b097e491fb5fe48466de30d12655b882d3b85f'
s: '0x377d1b9bb9bfbc3d565f34910240bd2cb81791dcf2016d07e595f1ada2c7ce15'
-
- '... More transactions here'
items:
type: object
properties:
blockHash:
type: string
example: '0xe82c5e6e0d2fb0fd9a28a5a7f55af3174b4420d1f82965b7940379d90e0e2837'
blockNumber:
type: string
example: '0x14c6b95'
from:
type: string
example: '0xe898563caf3b8ed945bd23e9f1a5eca1f395180e'
gas:
type: string
example: '0x203c76'
gasPrice:
type: string
example: '0x53d1ac1000'
hash:
type: string
example: '0xd664519ee6a2bab1031da8e56f814d9626878de9aedef2426a5356d572280f97'
input:
type: string
example: '0x38ed1739000000000000000000000000000000000000000000000000193e8f3326c4db0000000000000000000000000000000000000000000000000000b9a333dce606c800000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000e898563caf3b8ed945bd23e9f1a5eca1f395180e00000000000000000000000000000000000000000000000000000000619f915700000000000000000000000000000000000000000000000000000000000000020000000000000000000000002c89bbc92bd86f8075d1decc58c7f4e0107f286b0000000000000000000000007ceb23fd6bc0add59e62ac25578270cff1b9f619'
nonce:
type: string
example: '0x168ac'
to:
type: string
example: '0x1b02da8cb0d097eb8d57a175b88c7d8b47997506'
transactionIndex:
type: string
example: '0x0'
value:
type: string
example: '0x0'
type:
type: string
example: '0x0'
chainId:
type: string
example: '0x89'
v:
type: string
example: '0x136'
r:
type: string
example: '0xa1ac2567f13ba553713d4f21db8eb3617c04d51d7ed81964516aac8142528f52'
s:
type: string
example: '0x11ac82d2353d6441f6bf1e182fbfae73b315461d1283f8048098311aac699b6f'
transactionsRoot:
type: string
example: '0xdbab0c76f6a233225148be047c007572ffd7bd49b08d4da30c0a32fb5ae1ae02'
uncles:
type: array
example: []
-
description: ''
type: object
nullable: true
tags:
- 'Arbitrum Blockchain Queries'
parameters:
-
in: path
name: block_number
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '19151363'
/api/v2/arbitrum/transactions:
get:
summary: 'List Transactions'
operationId: listTransactions
description: "This method lists your transaction history. It lists all transactions including ERC20 and ERC721 transactions.
\n Please note that we dont index your addresses. We list only transactions that were made with the Chaingateway API"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Paginated result'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transactions'
current_page: 1
data:
-
id: 1
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.001000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T09:00:18.000000Z'
updated_at: '2024-02-13T09:00:18.000000Z'
-
id: 4
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0x5da4f33531fab8ecfe6f36a1300265f772b5f11c2da736a39b0b4b0c1b97c3e2'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.384200000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:01:26.000000Z'
updated_at: '2024-02-13T10:01:26.000000Z'
-
id: 5
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x1b7ecf53527e9a9ec09c448b2f594357e8a09f52c02c96d0de33fe435750d371'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:34:34.000000Z'
updated_at: '2024-02-13T10:34:34.000000Z'
-
id: 6
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x5b293a7289e8405fb8402f0bfa6e7464fdc9bfbc11aaa7874d4a7216b4079729'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:35:57.000000Z'
updated_at: '2024-02-13T10:35:57.000000Z'
-
id: 7
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x8830bd8d0cf0dfeac6d4cc345888ae52f9ca8b3a3cf37859919786bd9cd8ae2f'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '100.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:22:03.000000Z'
updated_at: '2024-02-13T12:22:03.000000Z'
-
id: 8
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:36:48.000000Z'
updated_at: '2024-02-13T12:36:48.000000Z'
first_page_url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
from: 1
last_page: 1
last_page_url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions'
per_page: 50
prev_page_url: null
to: 6
total: 6
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transactions'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 1
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.001000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T09:00:18.000000Z'
updated_at: '2024-02-13T09:00:18.000000Z'
-
id: 4
user_id: 1
blockchain: bsc
network: testnet
type: default
txid: '0x5da4f33531fab8ecfe6f36a1300265f772b5f11c2da736a39b0b4b0c1b97c3e2'
from: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress: null
amount: '0.384200000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:01:26.000000Z'
updated_at: '2024-02-13T10:01:26.000000Z'
-
id: 5
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x1b7ecf53527e9a9ec09c448b2f594357e8a09f52c02c96d0de33fe435750d371'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:34:34.000000Z'
updated_at: '2024-02-13T10:34:34.000000Z'
-
id: 6
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x5b293a7289e8405fb8402f0bfa6e7464fdc9bfbc11aaa7874d4a7216b4079729'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T10:35:57.000000Z'
updated_at: '2024-02-13T10:35:57.000000Z'
-
id: 7
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x8830bd8d0cf0dfeac6d4cc345888ae52f9ca8b3a3cf37859919786bd9cd8ae2f'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '100.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:22:03.000000Z'
updated_at: '2024-02-13T12:22:03.000000Z'
-
id: 8
user_id: 1
blockchain: bsc
network: testnet
type: ERC20
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
from: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
to: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
contractaddress: null
amount: '1.000000000000'
tokenid: null
responseJson: null
httpStatus: null
created_at: '2024-02-13T12:36:48.000000Z'
updated_at: '2024-02-13T12:36:48.000000Z'
items:
type: object
properties:
id:
type: integer
example: 1
user_id:
type: integer
example: 1
blockchain:
type: string
example: bsc
network:
type: string
example: testnet
type:
type: string
example: default
txid:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
from:
type: string
example: '0x261a8dE315f34b8e35B225e70159Dc612B3793dB'
to:
type: string
example: '0xbEA640f2BB84082Df3bFA459774c4A5b496CA054'
contractaddress:
type: string
example: null
amount:
type: string
example: '0.001000000000'
tokenid:
type: string
example: null
responseJson:
type: string
example: null
httpStatus:
type: string
example: null
created_at:
type: string
example: '2024-02-13T09:00:18.000000Z'
updated_at:
type: string
example: '2024-02-13T09:00:18.000000Z'
first_page_url:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://testnet.chaingateway.test:81/api/v2/bsc/transactions'
per_page:
type: integer
example: 50
prev_page_url:
type: string
example: null
to:
type: integer
example: 6
total:
type: integer
example: 6
tags:
- 'Arbitrum Transactions'
post:
summary: 'Create transaction'
operationId: createTransaction
description: 'This method creates a new transaction.
'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created'
data:
adderess: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created'
data:
type: object
properties:
adderess:
type: string
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
401:
description: 'Wrong password'
content:
application/json:
schema:
type: object
example:
status: 401
ok: false
message: 'Wrong password provided'
errors: []
properties:
status:
type: integer
example: 401
ok:
type: boolean
example: false
message:
type: string
example: 'Wrong password provided'
errors:
type: array
example: []
422:
description: 'Insufficent funds'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors:
type: array
example: []
tags:
- 'Arbitrum Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
amount:
type: string
description: 'The amount to send.'
example: '1000000000000000000'
gas:
type: integer
description: 'The gas limit for the transaction.'
example: 21000
gasprice:
type: number
description: 'The gas price for the transaction.'
example: 1000000000.0
maxPriorityFeePerGas:
type: number
description: 'The maximum priority fee per gas for the transaction.'
example: 1000000000.0
maxFeePerGas:
type: number
description: 'The maximum fee per gas for the transaction.'
example: 1000000000.0
password:
type: string
description: 'The password for the wallet. This field is required when privatekey is not present.'
example: password
privatekey:
type: string
description: ''
example: architecto
data:
type: string
description: 'The data for the transaction.'
example: 0x
nonce:
type: string
description: 'The nonce for the transaction.'
example: '0'
required:
- from
- to
- amount
parameters:
-
in: path
name: page
description: 'Optional parameter. The page number'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '1'
'/api/v2/arbitrum/transactions/{txid}':
get:
summary: 'Get transaction'
operationId: getTransaction
description: 'This method shows a transaction'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: Decoded
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction'
data:
transaction:
blockHash: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber: '37701506'
from: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gas: '21000'
gasPrice: '3.0000000000'
hash: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
nonce: '14'
to: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionIndex: '8'
maxFeePerGas: null
maxPriorityFeePerGas: null
amount: '0.001000000000000000'
contractaddress: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
type: ETH
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction'
data:
type: object
properties:
transaction:
type: object
properties:
blockHash:
type: string
example: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber:
type: string
example: '37701506'
from:
type: string
example: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gas:
type: string
example: '21000'
gasPrice:
type: string
example: '3.0000000000'
hash:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
nonce:
type: string
example: '14'
to:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionIndex:
type: string
example: '8'
maxFeePerGas:
type: string
example: null
maxPriorityFeePerGas:
type: string
example: null
amount:
type: string
example: '0.001000000000000000'
contractaddress:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
type:
type: string
example: ETH
422:
description: 'Transaction not found'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'transaction not found'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'transaction not found'
errors:
type: array
example: []
tags:
- 'Arbitrum Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
-
in: path
name: decoded
description: "Optional parameter. If set to 'decoded' it will return the decoded transaction"
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: decoded
'/api/v2/arbitrum/transactions/{txid}/decoded':
get:
summary: 'Get decoded transaction'
operationId: getDecodedTransaction
description: 'This method will decode the transaction and shows you human readable data of the transaction'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Transaction not found'
type: object
example:
status: 422
ok: false
message: 'transaction not found'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'transaction not found'
errors:
type: array
example: []
-
description: 'Transaction fetched'
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction'
data:
blockHash: '0x00bb7d10d61156c1972c8f817ac6bf408b8495a6484492f95ebad57f89fed581'
blockNumber: '67604928'
from: '0x899abf76af40336006df10b71680b925aa86b6f7'
gas: '93835'
gasPrice: '136.9438649750'
maxFeePerGas: '141.3817174220'
maxPriorityFeePerGas: '25.0000000000'
hash: '0x4409ddadf59391177b72ac005e88c3a334887f11ef552356e16477a13a671dd8'
input: '0x954093c40000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000003643aa6479e5a06fc30000000000000000000000000000000000000000000000000000000067a49a2c'
nonce: '174853'
to: '0xbce8b135053c6b9665c09c23d1ef422c48d00ab4'
transactionIndex: '122'
amount: '0'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction'
data:
type: object
properties:
blockHash:
type: string
example: '0x00bb7d10d61156c1972c8f817ac6bf408b8495a6484492f95ebad57f89fed581'
blockNumber:
type: string
example: '67604928'
from:
type: string
example: '0x899abf76af40336006df10b71680b925aa86b6f7'
gas:
type: string
example: '93835'
gasPrice:
type: string
example: '136.9438649750'
maxFeePerGas:
type: string
example: '141.3817174220'
maxPriorityFeePerGas:
type: string
example: '25.0000000000'
hash:
type: string
example: '0x4409ddadf59391177b72ac005e88c3a334887f11ef552356e16477a13a671dd8'
input:
type: string
example: '0x954093c40000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000003643aa6479e5a06fc30000000000000000000000000000000000000000000000000000000067a49a2c'
nonce:
type: string
example: '174853'
to:
type: string
example: '0xbce8b135053c6b9665c09c23d1ef422c48d00ab4'
transactionIndex:
type: string
example: '122'
amount:
type: string
example: '0'
tags:
- 'Arbitrum Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
-
in: path
name: decoded
description: "Optional parameter. If set to 'decoded' it will return the decoded transaction"
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: decoded
/api/v2/arbitrum/addresses:
post:
summary: 'Create Address'
operationId: createAddress
description: "Creates a new address wich can be used to send and receive crypto currencies, ERC20 and ERC721 tokens.\nplease provide a stron password within the request body. You will need the password everytime you interact with your address.\n\nThere are two ways to create an Address:\n- unsecure: You will directly get the private key of your address which can be used to create transactions\n- secure: You define a password, the privatekley will use this password as well as our own encryption chain to store the privatekey on our database. You can use this password instead of a private key to create transactions\n\n\n"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Address created'
data:
adderess: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Address created'
data:
type: object
properties:
adderess:
type: string
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
422:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
-
description: ''
type: object
example:
status: 422
ok: false
message: 'Your address limit exceeded. Please upgrade your plan'
data: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Your address limit exceeded. Please upgrade your plan'
data:
type: array
example: []
tags:
- 'Arbitrum Addresses'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
get:
summary: 'List addresses'
operationId: listAddresses
description: 'Lists all addresses you have created but not yet deleted'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Arbitrum Addresses'
'/api/v2/arbitrum/addresses/{address}':
delete:
summary: 'Delete Address'
operationId: deleteAddress
description: 'This method will delete your address. This decreases your used address metrics'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Address deleted'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Address deleted'
data:
type: array
example: []
tags:
- 'Arbitrum Addresses'
post:
summary: 'Update Address Password'
operationId: updateAddressPassword
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Password updated'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Password updated'
data:
type: array
example: []
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- 'Arbitrum Addresses'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
old_password:
type: string
description: 'The old password of the user.'
example: old_password123
new_password:
type: string
description: 'The new password of the user.'
example: new_password123
required:
- old_password
- new_password
parameters:
-
in: path
name: address
description: 'The address you want to delete.'
example: '0xd280406b68901ae4F2431d1830dF5232F49C19fA'
required: true
schema:
type: string
'/api/v2/arbitrum/balances/{address}':
get:
summary: 'Get balance of an address'
operationId: getBalanceOfAnAddress
description: 'Get the balance of an address'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Balance fetched'
data: '0.000000000000000000'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Balance fetched'
data:
type: string
example: '0.000000000000000000'
tags:
- 'Arbitrum Blockchain Queries'
parameters:
-
in: path
name: address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0x2214C41B139d8752bf8Bf17BDfee5B6EA4E3157B'
'/api/v2/arbitrum/balances/{address}/erc20/{contract_address}':
get:
summary: 'Get balance of an ERC20 token'
operationId: getBalanceOfAnERC20Token
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
200:
description: ''
content:
application/json:
schema:
type: string
example: '{ "status": 200, "ok": true, "message": "ERC20 balance fetched", "data": "0.000000" }'
tags:
- 'Arbitrum Blockchain Queries'
parameters:
-
in: path
name: address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0x2214C41B139d8752bf8Bf17BDfee5B6EA4E3157B'
-
in: path
name: contract_address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0x388C818CA8B9251b393131C08a736A67ccB19297'
'/api/v2/arbitrum/addresses/export/{address}':
post:
summary: ''
operationId: postApiV2ArbitrumAddressesExportAddress
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Private key exported'
data:
private_key: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Private key exported'
data:
type: object
properties:
private_key:
type: string
example: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- 'Arbitrum Addresses'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
parameters:
-
in: path
name: address
description: ''
example: architecto
required: true
schema:
type: string
/api/v2/arbitrum/addresses/import:
post:
summary: 'Import Private Key'
operationId: importPrivateKey
description: 'Import a Private key to use the secure wallet functionality for transactions.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Address imported successfully'
data: []
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Address imported successfully'
data:
type: array
example: []
tags:
- 'Arbitrum Addresses'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
address:
type: string
description: ''
example: architecto
privatekey:
type: string
description: ''
example: architecto
password:
type: string
description: ''
example: architecto
required:
- address
- privatekey
- password
/api/v2/arbitrum/transactions/erc20:
post:
summary: 'Create ERC20 transaction'
operationId: createERC20Transaction
description: 'This method creates a new ERC20 transaction.
'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created'
data:
adderess: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created'
data:
type: object
properties:
adderess:
type: string
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
401:
description: 'Wrong password'
content:
application/json:
schema:
type: object
example:
status: 401
ok: false
message: 'Wrong password provided'
errors: []
properties:
status:
type: integer
example: 401
ok:
type: boolean
example: false
message:
type: string
example: 'Wrong password provided'
errors:
type: array
example: []
422:
description: 'Insufficent funds'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors:
type: array
example: []
tags:
- 'Arbitrum Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
contractaddress:
type: string
description: 'The address of the ERC20 contract. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
gas:
type: integer
description: 'The gas limit for the transaction.'
example: 21000
gasprice:
type: number
description: 'The gas price for the transaction.'
example: 1000000000.0
maxPriorityFeePerGas:
type: number
description: 'The maximum priority fee per gas for the transaction.'
example: 1000000000.0
maxFeePerGas:
type: number
description: 'The maximum fee per gas for the transaction.'
example: 1000000000.0
password:
type: string
description: 'The password to unlock the wallet if you working with a password protected wallet created with chaingateway. . This field is required when privatekey is not present.'
example: password123
privatekey:
type: string
description: 'The private key to sign the transaction, only needed if working with non-secure chaingateway wallet.'
example: '0x123456'
nonce:
type: string
description: 'The nonce for the transaction.'
example: '0x123456'
amount:
type: number
description: 'The amount of the ERC20 token to send.'
example: 100.0
required:
- from
- contractaddress
- to
- amount
/api/v2/arbitrum/transactions/erc721:
post:
summary: 'Create ERC721 transaction'
operationId: createERC721Transaction
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: 'Succesfully created'
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Succesfully created'
data:
txid: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully created'
data:
type: object
properties:
txid:
type: string
example: '0x73344d178812d4919e9002c560781f288030edf72ece88823ef1c377dfb71f27'
401:
description: 'Wrong password'
content:
application/json:
schema:
type: object
example:
status: 401
ok: false
message: 'Wrong password provided'
errors: []
properties:
status:
type: integer
example: 401
ok:
type: boolean
example: false
message:
type: string
example: 'Wrong password provided'
errors:
type: array
example: []
422:
description: 'Insufficent funds'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000'
errors:
type: array
example: []
tags:
- 'Arbitrum Transactions'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'The address to send the transaction from. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
contractaddress:
type: string
description: 'The address of the ERC721 contract. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
to:
type: string
description: 'The address to send the transaction to. Must match the regex /^(0x)?[0-9a-f]{40}$/i.'
example: '0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2'
tokenId:
type: integer
description: 'The token ID to send.'
example: 1
gas:
type: integer
description: 'The gas limit for the transaction.'
example: 21000
gasprice:
type: number
description: 'The gas price for the transaction.'
example: 1000000000.0
maxPriorityFeePerGas:
type: number
description: ''
example: 4326.41688
maxFeePerGas:
type: number
description: ''
example: 4326.41688
password:
type: string
description: 'This field is required when privatekey is not present.'
example: '|]|{+-'
privatekey:
type: string
description: ''
example: architecto
data:
type: string
description: ''
example: architecto
nonce:
type: string
description: ''
example: architecto
required:
- from
- contractaddress
- to
- tokenId
'/api/v2/arbitrum/erc20/{contract_address}':
get:
summary: 'Get ERC20 contract information'
operationId: getERC20ContractInformation
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'ERC20 contract fetched'
type: object
example:
status: 200
ok: true
message: 'ERC20 contract fetched'
data:
contractaddress: '0xdAC17F958D2ee523a2206206994597C13D831ec7'
decimals: 6
totalSupply: '51998658367.642960'
name: TetherUSD
symbol: USDT
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'ERC20 contract fetched'
data:
type: object
properties:
contractaddress:
type: string
example: '0xdAC17F958D2ee523a2206206994597C13D831ec7'
decimals:
type: integer
example: 6
totalSupply:
type: string
example: '51998658367.642960'
name:
type: string
example: TetherUSD
symbol:
type: string
example: USDT
-
description: ''
type: object
example:
status: success
data: data
properties:
status:
type: string
example: success
data:
type: string
example: data
tags:
- 'Arbitrum Blockchain Queries'
parameters:
-
in: path
name: contract_address
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '0x388C818CA8B9251b393131C08a736A67ccB19297'
'/api/v2/arbitrum/transactions/{txid}/receipt/{decoded}':
get:
summary: 'Get receipt'
operationId: getReceipt
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: Decoded
type: object
example:
status: 200
ok: true
message: 'Succesfully parsedtransaction receipt'
data:
transaction:
blockHash: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber: '37701506'
cumulativeGasUsed: '627702'
effectiveGasPrice: '3.0000000000'
from: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed: '21000'
logs: []
logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status: true
to: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex: '8'
type: '8'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsedtransaction receipt'
data:
type: object
properties:
transaction:
type: object
properties:
blockHash:
type: string
example: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber:
type: string
example: '37701506'
cumulativeGasUsed:
type: string
example: '627702'
effectiveGasPrice:
type: string
example: '3.0000000000'
from:
type: string
example: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed:
type: string
example: '21000'
logs:
type: array
example: []
logsBloom:
type: string
example: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status:
type: boolean
example: true
to:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex:
type: string
example: '8'
type:
type: string
example: '8'
-
description: Encoded
type: object
example:
status: 200
ok: true
message: 'Succesfully parsed transaction receipt'
data:
transaction:
blockHash: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber: '0x23f4782'
contractAddress: null
cumulativeGasUsed: '0x993f6'
effectiveGasPrice: '0xb2d05e00'
from: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed: '0x5208'
logs: []
logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status: '0x1'
to: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex: '0x8'
type: '0x0'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Succesfully parsed transaction receipt'
data:
type: object
properties:
transaction:
type: object
properties:
blockHash:
type: string
example: '0xf062efe5e23fbd70c05834c8ae6a329d02e8afb1673a8665906945dae74f86e6'
blockNumber:
type: string
example: '0x23f4782'
contractAddress:
type: string
example: null
cumulativeGasUsed:
type: string
example: '0x993f6'
effectiveGasPrice:
type: string
example: '0xb2d05e00'
from:
type: string
example: '0x261a8de315f34b8e35b225e70159dc612b3793db'
gasUsed:
type: string
example: '0x5208'
logs:
type: array
example: []
logsBloom:
type: string
example: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
status:
type: string
example: '0x1'
to:
type: string
example: '0xbea640f2bb84082df3bfa459774c4a5b496ca054'
transactionHash:
type: string
example: '0xf5ed14c69911b1f15fa19946e7572486ec01d6fd40c3044753924798bc88d72b'
transactionIndex:
type: string
example: '0x8'
type:
type: string
example: '0x0'
422:
description: 'Transaction receipt not found'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'transaction not found'
errors: []
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'transaction not found'
errors:
type: array
example: []
tags:
- 'Arbitrum Transactions'
parameters:
-
in: path
name: txid
description: 'The transaction hash'
example: '0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8'
required: true
schema:
type: string
-
in: path
name: decoded
description: "Optional parameter. If set to 'decoded' it will return the decoded transaction"
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: decoded
'/api/v2/arbitrum/addresses/export/{address}/privatekey':
post:
summary: ''
operationId: postApiV2ArbitrumAddressesExportAddressPrivatekey
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Private key exported'
data:
private_key: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Private key exported'
data:
type: object
properties:
private_key:
type: string
example: 7d3bC832A0860fD882FF4C2359e10268f4E5CCf8
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
password:
- 'The password field is required.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- 'Arbitrum Addresses'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: ''
example: '|]|{+-'
parameters:
-
in: path
name: address
description: ''
example: architecto
required: true
schema:
type: string
/api/v2/arbitrum/gasprice:
get:
summary: 'Get Gas Price'
operationId: getGasPrice
description: 'This Method returns the gas price'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'Gas price fetched'
content:
application/json:
schema:
type: object
example:
ok: true
status: 200
message: 'Successfully parsed'
data:
gasPrice: '12.28'
properties:
ok:
type: boolean
example: true
status:
type: integer
example: 200
message:
type: string
example: 'Successfully parsed'
data:
type: object
properties:
gasPrice:
type: string
example: '12.28'
tags:
- 'Arbitrum Blockchain Queries'
'/api/v2/arbitrum/nfts/{contract_address}/owner/{token_id}':
get:
summary: 'Get NFT Owner'
operationId: getNFTOwner
description: 'This Method returns the owner of an NFT'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'ERC721 owner fetched'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'ERC721 owner fetched'
data:
owner: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'ERC721 owner fetched'
data:
type: object
properties:
owner:
type: string
example: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
422:
description: 'Error! Could not get NFT owner'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Error! Could not get NFT owner'
error: 'Error message here'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Error! Could not get NFT owner'
error:
type: string
example: 'Error message here'
tags:
- 'Arbitrum Blockchain Queries'
parameters:
-
in: path
name: contract_address
description: 'The contract address'
example: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
required: true
schema:
type: string
-
in: path
name: token_id
description: 'The token id'
example: '1234'
required: true
schema:
type: string
'/api/v2/arbitrum/nfts/{contract_address}/uri/{token_id}':
get:
summary: 'Get NFT Token URI'
operationId: getNFTTokenURI
description: 'This Method returns the URI of an NFT token'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: 'NFT token URI fetched'
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'NFT token URI fetched'
data:
tokenURI: 'https://api.opensea.io/api/v1/metadata/0x06012c8cf97bead5deae237070f9587f8e7a266d/1'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'NFT token URI fetched'
data:
type: object
properties:
tokenURI:
type: string
example: 'https://api.opensea.io/api/v1/metadata/0x06012c8cf97bead5deae237070f9587f8e7a266d/1'
422:
description: 'Error! Could not get NFT token URI'
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Error! Could not get NFT token URI'
error: 'Error message here'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Error! Could not get NFT token URI'
error:
type: string
example: 'Error message here'
tags:
- 'Arbitrum Blockchain Queries'
parameters:
-
in: path
name: contract_address
description: 'The contract address'
example: '0x5e032243d507c743b061ef021e2ec7fcc6d3ab89'
required: true
schema:
type: string
-
in: path
name: token_id
description: 'The token id'
example: '1234'
required: true
schema:
type: string
'/api/v2/arbitrum/balances/{address}/erc20':
get:
summary: 'Display all the token balances of a wallet'
operationId: displayAllTheTokenBalancesOfAWallet
description: ''
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Arbitrum Blockchain Queries'
parameters:
-
in: path
name: address
description: ''
example: architecto
required: true
schema:
type: string
/api/v2/arbitrum/webhooks:
get:
summary: 'Get all webhooks'
operationId: getAllWebhooks
description: 'Lists all webhooks created by the user.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Arbitrum Webhooks'
post:
summary: 'Create webhook'
operationId: createWebhook
description: 'Creates a new webhook for real-time communication and event notification.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
status: 201
ok: true
message: 'Webhook created'
data:
webhook: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
properties:
status:
type: integer
example: 201
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook created'
data:
type: object
properties:
webhook:
type: string
example: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
422:
description: ''
content:
application/json:
schema:
type: object
example:
status: 422
ok: false
message: 'Data validation failed'
errors:
status: 422
ok: false
message: 'Data validation failed'
errors:
from:
- 'The from field format is invalid.'
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
status:
type: integer
example: 422
ok:
type: boolean
example: false
message:
type: string
example: 'Data validation failed'
errors:
type: object
properties:
from:
type: array
example:
- 'The from field format is invalid.'
items:
type: string
tags:
- 'Arbitrum Webhooks'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'Sender address (required if not "to"). This field is required when to is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
to:
type: string
description: 'Receiver address (required if not providing "from"). This field is required when from is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
url:
type: string
description: 'URL for webhook notifications (required). Must be a valid URL.'
example: 'http://vonrueden.com/'
contractaddress:
type: string
description: 'The Address of an Contract you want to track (Not allowwed on Bitcoin). This field is required when none of from and to are present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
token_id:
type: string
description: 'This field is required when none of from and to are present.'
example: null
type:
type: string
description: ''
example: ERC20
enum:
- ETH
- ERC20
- ERC721
reference:
type: string
description: 'A reference for the webhook. Must not be greater than 255 characters.'
example: 'n'
nullable: true
required:
- url
'/api/v2/arbitrum/webhooks/{id}':
get:
summary: 'Get webhook'
operationId: getWebhook
description: 'Show the details of a Webhook'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Arbitrum Webhooks'
put:
summary: 'Update webhook'
operationId: updateWebhook
description: 'Updates an existing webhook with the provided data.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: true
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Webhook updated'
data:
id: 9b73d6ee-8a8b-44c3-b2c6-0bd1e1d8cd9a
from: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
to: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
contractaddress: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
type: BEP20
token_id: null
url: 'http://blanda.com/debitis-et-id-nisi-qui-id.html'
is_active: true
is_invalid: false
old_id: null
created_at: '2024-02-29T14:51:35.000000Z'
updated_at: '2024-02-29T14:52:33.000000Z'
deleted_at: null
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook updated'
data:
type: object
properties:
id:
type: string
example: 9b73d6ee-8a8b-44c3-b2c6-0bd1e1d8cd9a
from:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
to:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
contractaddress:
type: string
example: '0xe01e45c4d35e596cc2aEFABAe1c08FDa9fAc4241'
type:
type: string
example: BEP20
token_id:
type: string
example: null
url:
type: string
example: 'http://blanda.com/debitis-et-id-nisi-qui-id.html'
is_active:
type: boolean
example: true
is_invalid:
type: boolean
example: false
old_id:
type: string
example: null
created_at:
type: string
example: '2024-02-29T14:51:35.000000Z'
updated_at:
type: string
example: '2024-02-29T14:52:33.000000Z'
deleted_at:
type: string
example: null
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: 404
ok: false
message: 'Webhook not found'
data: []
properties:
status:
type: integer
example: 404
ok:
type: boolean
example: false
message:
type: string
example: 'Webhook not found'
data:
type: array
example: []
tags:
- 'Arbitrum Webhooks'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: 'Sender address (required if not "to"). This field is required when to is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
to:
type: string
description: 'Receiver address (required if not providing "from"). This field is required when from is not present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
url:
type: string
description: 'URL for webhook notifications (required). Must be a valid URL.'
example: 'http://vonrueden.com/'
contractaddress:
type: string
description: 'The Address of an Contract you want to track (Not allowwed on Bitcoin). This field is required when none of from and to are present. Must match the regex /^0x[a-fA-F0-9]{40}$/.'
example: '0x922815dFbEa128eAeaAAa185508fe078bECeFBBE'
token_id:
type: string
description: 'This field is required when none of from and to are present.'
example: null
type:
type: string
description: ''
example: ERC20
enum:
- ETH
- ERC20
- ERC721
reference:
type: string
description: 'A reference for the webhook. Must not be greater than 255 characters.'
example: 'n'
nullable: true
required:
- url
delete:
summary: 'Delete webhook'
operationId: deleteWebhook
description: 'This method will delete the specified webhook.'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Webhook deleted'
data: []
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Webhook deleted'
data:
type: array
example: []
tags:
- 'Arbitrum Webhooks'
parameters:
-
in: path
name: id
description: 'The UUID of the webhook you want to show.'
example: 9b2b4dcc-1479-4bcd-9b8a-015673e80f46
required: true
schema:
type: string
/api/v2/arbitrum/webhooks/notifications:
get:
summary: 'Display all Webhook Notifications'
operationId: displayAllWebhookNotifications
description: 'Lists all webhook notifications created by the user for the specific Blockchain and Network'
parameters:
-
in: query
name: page
description: 'The page number to fetch'
example: 16
required: false
schema:
type: integer
description: 'The page number to fetch'
example: 16
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully fetched notifications'
current_page: 1
data:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
from: 1
last_page: 1
last_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications'
per_page: 15
prev_page_url: null
to: 1
total: 1
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully fetched notifications'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
items:
type: object
properties:
id:
type: string
example: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id:
type: string
example: 9ba897da-7651-4df6-80ef-11c898b195e5
txid:
type: string
example: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type:
type: string
example: TRC20
contractaddress:
type: string
example: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from:
type: string
example: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to:
type: string
example: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid:
type: string
example: null
amount:
type: string
example: null
blocknumber:
type: string
example: '19499380'
status:
type: string
example: failed
url:
type: string
example: 'https://example.com'
success:
type: boolean
example: false
attempts:
type: integer
example: 0
created_at:
type: string
example: '2024-05-05T19:33:52.000000Z'
updated_at:
type: string
example: '2024-05-05T19:33:54.000000Z'
network:
type: string
example: testnet
blockchain:
type: string
example: tron
response:
type: string
example: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications'
per_page:
type: integer
example: 15
prev_page_url:
type: string
example: null
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'Arbitrum Webhooks'
/api/v2/arbitrum/webhooks/notifications/failed:
get:
summary: 'Display all failed Webhook Notification'
operationId: displayAllFailedWebhookNotification
description: "Lists all failed webhook notifications created by the user for the specific Blockchain and Network\nBased on the response you can use our /webhooks/notifications/{id}/retry to retry every failed webhook.\n\nAfter you started the retry process, the webhook will be removed from this list. should the retry process fail, the webhook will be added back to this list."
parameters:
-
in: query
name: page
description: 'The page number to fetch'
example: 16
required: false
schema:
type: integer
description: 'The page number to fetch'
example: 16
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Successfully fetched failed notifications'
current_page: 1
data:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
from: 1
last_page: 1
last_page_url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
links:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
next_page_url: null
path: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed'
per_page: 15
prev_page_url: null
to: 1
total: 1
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Successfully fetched failed notifications'
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id: 9ba897da-7651-4df6-80ef-11c898b195e5
txid: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type: TRC20
contractaddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid: null
amount: null
blocknumber: '19499380'
status: failed
url: 'https://example.com'
success: false
attempts: 0
created_at: '2024-05-05T19:33:52.000000Z'
updated_at: '2024-05-05T19:33:54.000000Z'
network: testnet
blockchain: tron
response: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
items:
type: object
properties:
id:
type: string
example: 9ba28088-81d8-4aab-b711-650525081fe1
webhook_id:
type: string
example: 9ba897da-7651-4df6-80ef-11c898b195e5
txid:
type: string
example: '0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15'
type:
type: string
example: TRC20
contractaddress:
type: string
example: '0xdac17f958d2ee523a2206206994597c13d831ec7'
from:
type: string
example: '0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460'
to:
type: string
example: '0x238a879d973e127193b1a2fdc4f6410cd5289da5'
tokenid:
type: string
example: null
amount:
type: string
example: null
blocknumber:
type: string
example: '19499380'
status:
type: string
example: failed
url:
type: string
example: 'https://example.com'
success:
type: boolean
example: false
attempts:
type: integer
example: 0
created_at:
type: string
example: '2024-05-05T19:33:52.000000Z'
updated_at:
type: string
example: '2024-05-05T19:33:54.000000Z'
network:
type: string
example: testnet
blockchain:
type: string
example: tron
response:
type: string
example: '{"status":"success","message":"Hooraa! Successfully received by demo receiver.","data":{"id":"9ba28088-81d8-4aab-b711-650525081fee","webhook_id":"9ba27cd9-abdb-4c71-994f-e9e2de73af88","from":"0xb23360ccdd9ed1b15d45e5d3824bb409c8d7c460","to":"0x238a879d973e127193b1a2fdc4f6410cd5289da5","blocknumber":"19499380","datetime":"2024-03-23 19:33:54","tokenid":null,"type":"ERC20","contractaddress":"0xdac17f958d2ee523a2206206994597c13d831ec7","txid":"0x8bb1ff22f084fe5098288a17dd6641f02cfcd9a4e923a342aa45dc78e178fc15","amount":null}}'
first_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'http://192.168.178.100:81/api/v2/tron/webhooks/notifications/failed'
per_page:
type: integer
example: 15
prev_page_url:
type: string
example: null
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'Arbitrum Webhooks'
'/api/v2/arbitrum/webhooks/notifications/{id}/retry':
post:
summary: 'Retry a failed Webhook Notification'
operationId: retryAFailedWebhookNotification
description: 'Retries a failed webhook notification'
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses: { }
tags:
- 'Arbitrum Webhooks'
parameters:
-
in: path
name: id
description: 'The ID of the notification.'
example: architecto
required: true
schema:
type: string
'/api/v2/market/price/{crypto}/{fiat}':
get:
summary: 'Get the price of a cryptocurrency in a fiat currency.'
operationId: getThePriceOfACryptocurrencyInAFiatCurrency
description: "This endpoint returns the current price of a cryptocurrency in a fiat currency.\n\nAllowed fiat currencies are: usd, eur\n\nAllowed cryptocurrencies are: btc, eth, usdt, bnb, sol, usdc, xrp, steth, doge, trx, ton, ada, wsteth, wbtc, avax, shib, weth, link, bch, dot, leo, dai, ltc, uni, near, weeth, kas, matic, icp, xmr, pepe, apt, fet, usde, fdusd, xlm, etc, okb, sui, stx, cro, fil, render, imx, tao, mnt, aave, hbar, arb, vet, atom, op, wbt, mkr, inj, wif, weth, bgb, ar, reth, grt, rune, hnt, meth, floki, bonk, theta, solvbtc, ftm, algo, gt, kcs, jup, pyth, pyusd, ezeth, bsv, tia, qnt, ldo, jasmy, sei, weth, ondo, flow, ftn, eeth, om, core, not, btt, usdd, klay, egld, eos, flr, brett, gala, axs, strk, btc, eth, usdt, bnb, sol, usdc, xrp, steth, doge, trx, ton, ada, wsteth, wbtc, avax, shib, weth, link, bch, dot, leo, dai, ltc, uni, near, weeth, kas, matic, icp, xmr, pepe, apt, fet, usde, fdusd, xlm, etc, okb, sui, stx, cro, fil, render, imx, tao, mnt, aave, hbar, arb, vet, atom, op, wbt, mkr, inj, wif, weth, bgb, ar, reth, grt, rune, hnt, meth, floki, bonk, theta, solvbtc, ftm, algo, gt, kcs, jup, pyth, pyusd, ezeth, bsv, tia, qnt, ldo, sei, jasmy, weth, ondo, flow, ftn, eeth, om, core, not, btt, usdd, klay, egld, eos, flr, brett, gala, axs, strk"
parameters:
-
in: header
name: X-Network
description: 'Specify "testnet" for test network or leave empty for main network. Defaults to "mainnet" if not provided.'
required: false
schema:
type: string
enum:
- testnet
- mainnet
default: mainnet
-
in: header
name: Authorization
description: 'Bearer token for authorization. Required for authenticated endpoints.'
required: true
schema:
type: string
-
in: header
name: Content-Type
description: 'The MIME type of the request body.'
required: false
schema:
type: string
enum:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
default: application/json
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: 200
ok: true
message: 'Market data for bnb'
data:
price: '701.22'
properties:
status:
type: integer
example: 200
ok:
type: boolean
example: true
message:
type: string
example: 'Market data for bnb'
data:
type: object
properties:
price:
type: string
example: '701.22'
tags:
- 'Cryptocurrency Prices'
parameters:
-
in: path
name: crypto
description: 'The cryptocurrency symbol'
example: bnb
required: true
schema:
type: string
-
in: path
name: fiat
description: 'The fiat currency symbol'
example: usd
required: true
schema:
type: string
x-tagGroups:
-
name: Account
tags:
- ''
-
name: 'Tron API'
tags:
- 'Tron Blockchain Queries'
- 'Tron Transactions'
- 'Tron Addresses'
- 'Tron Staking'
- 'Tron Paymaster'
- 'Tron Webhooks'
-
name: 'Ethereum API'
tags:
- 'Ethereum Blockchain Queries'
- 'Ethereum Transactions'
- 'Ethereum Addresses'
- 'Ethereum Webhooks'
-
name: 'Binance Smart Chain API'
tags:
- 'BSC Blockchain Queries'
- 'BSC Transactions'
- 'BSC Addresses'
- 'BSC Webhooks'
-
name: 'Solana API'
tags:
- 'Solana Addresses'
- 'Solana Blockchain Queries'
- 'Solana Transactions'
-
name: 'Polygon API'
tags:
- 'Polygon Blockchain Queries'
- 'Polygon Transactions'
- 'Polygon Addresses'
- 'Polygon Webhooks'
-
name: 'Bitcoin API'
tags:
- 'Bitcoin Blockchain Queries'
- 'Bitcoin Transactions'
- 'Bitcoin Wallets'
- 'Bitcoin Webhooks'
-
name: 'Arbitrum API'
tags:
- 'Arbitrum Blockchain Queries'
- 'Arbitrum Transactions'
- 'Arbitrum Addresses'
- 'Arbitrum Webhooks'
-
name: 'Market Data'
tags:
- 'Cryptocurrency Prices'