This document describes the specification for the API Miner public API.
This document has the specification, the main documentation can be found on the official Blockwell Docs website:
All users are limited to 10 requests per second and 3600 requests per hour.
Contact us if you need higher limits.
Contact us at:
General Blockwell chat: Blockwell Telegram
View the changelog at docs.blockwell.ai/tools/apiminer/changelog.html
List Token contracts belonging to the current user.
network | string Optional. Filter by network, see Ethereum networks. |
name | string Optional. Filter by Token name. |
symbol | string Optional. Filter by Token symbol. |
Array of objects (Token contract) |
{- "data": [
- {
- "id": "6ab34922-0561-48b7-9e11-ce1581e100f2",
- "name": "API Miner Coin",
- "network": "rinkeby",
- "address": "0x418f8020b48731ffd2a99afe0aa5e7d66ca263d8",
- "type": "erc20",
- "parameters": {
- "symbol": "APIMC",
- "decimals": 18,
- "supply": "100000000000000000000000000"
}
}
]
}
Get a specific token by its unique identifier.
contractId required | string ID of the token |
object (Token contract) |
{- "data": {
- "id": "6ab34922-0561-48b7-9e11-ce1581e100f2",
- "name": "API Miner Coin",
- "network": "rinkeby",
- "address": "0x418f8020b48731ffd2a99afe0aa5e7d66ca263d8",
- "type": "erc20",
- "parameters": {
- "symbol": "APIMC",
- "decimals": 18,
- "supply": "100000000000000000000000000"
}
}
}
Get the specified token balance for the current user's default account.
contractId required | string ID of the token. |
data | string Token balance of the address in the smallest unit. |
{- "data": "1000000000000000000"
}
Get the specified token balance for a specific account.
contractId required | string ID of the token. |
address required | string Address to get balance for. |
data | string Token balance of the address in the smallest unit. |
{- "data": "1000000000000000000"
}
Gets the transfer history for the specified token.
from | string Filter transfers by the from address. |
to | string Filter transfers by the to address. |
address | string Filter transfers where this address is either the sender or recipient. |
Array of objects (Token transfer) |
{- "data": [
- {
- "from": "0x0000000000000000000000000000000000000000",
- "to": "0xE7341C22c42a8150F521d70a5A1CeAD66727f462",
- "value": "6",
- "transactionHash": "0xdc03bf477c8f4e1279e35762346b69d29ed1bc93912eeb636c10f8fb14ae4781",
- "blockNumber": 157
}, - {
- "from": "0xE7341C22c42a8150F521d70a5A1CeAD66727f462",
- "to": "0x341481CeaC83d8C348508A3A13d1b4eac5a48186",
- "value": "1",
- "transactionHash": "0x00fef6c85aac9f34b0353859e479035dc1a92a7d9947423342b0743f9bc38fea",
- "blockNumber": 164
}
]
}
Submit a Token transfer to the blockchain.!!
Success means the transfer was accepted for processing, but there are no guarantees as to when the processing will be done. Processing happens on first-come-first-served basis.
A successful response contains a unique ID for the transaction, which can then be used to query its status.
Passing the optional callbacks
parameter in the body will add a web callback
that gets called once the transaction completes.
The callback payload is {"transaction": Transaction}
, with the same formatting
as with getting a transaction.
contractId required | string ID of the token. |
Token transfer request body.
to required | string Ethereum address to send Tokens to. |
value required | string^[0-9]$ Amount of Tokens to transfer, in the Token's smallest unit. |
from | string Address to send from, as either an Ethereum address, or an account ID. If not specified, the current user's default account will be used. |
callbacks | Array of strings Callback URL(s) to be notified when the Token transfer completes. See Callbacks for more details. |