Skip to main content

Get Native Token Transfers By Account

POST
Retrieves the native token transfer history associated with a specific address. The token type may vary depending on the selected chain. (e.g.,For Bitcoin, you can query BTC transfer history.)
Path Parameters
chainstringrequired
Parameter specifying the target chain to query.
networkstringrequired
Parameter specifying the network of the target chain.
Request Body
accountAddressstringrequired
Parameter specifying the account address to query.
relationstring
Parameter for filtering transactions where the queried account address is the sender or recipient.
  • from: Filter by sender only.
  • to: Filter by recipient only.
  • both (default): Returns all transactions where the queried address appears in from or to.
fromBlockstring
Parameter specifying the starting block for the query. You can enter one of the following formats:
  • block number: Enter block number as a decimal string.
  • block hash: 64-character hexadecimal (excluding "0x").
  • block tag: Use "earliest" or "latest" to specify the first block or the most recent block.
Notes:
  • This field cannot be used together with fromDate and toDate.
  • If provided without fromBlock, results are queried from genesis block to this block.
  • toBlock value cannot be less than fromBlock value.
  • If fromBlock and toBlock have the same value, only that block is queried.
  • "earliest" for toBlock is only allowed when fromBlock is "earliest".
  • If fromBlock and toBlock are not provided, the API queries data from the latest 30 days.
toBlockstring
Parameter specifying the ending block for the query. You can enter one of the following formats:
  • block number: Enter block number as a decimal string.
  • block hash: 64-character hexadecimal (excluding "0x").
  • block tag: Use "earliest" or "latest" to specify the first block or the most recent block.
Notes:
  • This field cannot be used together with fromDate and toDate.
  • If provided without fromBlock, results are queried from genesis block to this block.
  • toBlock value cannot be less than fromBlock value.
  • If fromBlock and toBlock have the same value, only that block is queried.
  • "earliest" for toBlock is only allowed when fromBlock is "earliest".
  • If fromBlock and toBlock are not provided, the API queries data from the latest 30 days.
fromDatestring
Parameter specifying the start date for the query. Date must follow ISO 8601 format (YYYY-MM-DDThh:mm:ss{time zone}) including seconds.Notes:
  • If provided without toDate, results are queried from this date to the latest block.
  • fromDate value must be equal to or earlier than toDate value.
  • If fromDate and toDate have the same value, only blocks from that date are queried.
  • This field cannot be used together with fromBlock and toBlock.
  • If fromDate and toDate are not provided, the API queries data from the latest 30 days.
toDatestring
Parameter specifying the end date for the query. Date must follow ISO 8601 format (YYYY-MM-DDThh:mm:ss{time zone}) including seconds.Notes:
  • If provided without fromDate, results are queried from genesis block to this date.
  • toDate value must be equal to or later than fromDate value.
  • If fromDate and toDate have the same value, only blocks from that date are queried.
  • This field cannot be used together with fromBlock and toBlock.
  • If fromDate and toDate are not provided, the API queries data from the latest 30 days.
pageinteger
The page parameter specifies the data page to query. It accepts values up to 100; for pages exceeding 100, use the cursor pagination method.The page and cursor parameters cannot be used together. If both page and cursor are empty, cursor pagination is used.
rppinteger
rpp stands for results per page and specifies the page size. You can specify a number greater than 0 and up to 100.
cursorstring
The cursor parameter supports pagination and data navigation between pages. Provide the cursor value from the previous page in the next request to load the next page of data.The page and cursor parameters cannot be used together. If both page and cursor are empty, cursor pagination is used.
withCountboolean
Parameter specifying whether to include the count field in the response. The count field indicates the total number of requested data items. When set to true, the count field is included and response speed may be slower.
Responses
pageinteger
Field representing the page number specified in the page parameter. This field is only included in the response when a value greater than 0 is specified for the page parameter.
rppinteger
Field representing the number of results per page specified in the rpp parameter.
cursorstring
A field for cursor pagination. This value must be provided in the next request to load the next page of data.
countinteger
Field representing the total count of requested data. This field is only included in the response when true is set for the withCount parameter.
Field representing the actual range applied to the query. The same kind of values used in the request's range parameters are returned. A Date-based request returns fromDate and toDate, a Block-based request returns fromBlock and toBlock, and a Ledger-based request returns fromLedger and toLedger; different kinds are never mixed in a single response. When all range parameters are omitted, a default window of the last 30 days is applied and fromDate, toDate are returned. Block and Ledger values are always returned as heights (numbers), even if a hash or tag (latest, earliest) was provided in the request.
fromDatestring
Field representing the start of the query range in Date mode. Returned in ISO 8601 format.
toDatestring
Field representing the end of the query range in Date mode. Returned in ISO 8601 format.
fromBlockinteger
Field representing the start block height of the query range in Block mode.
toBlockinteger
Field representing the end block height of the query range in Block mode.
fromLedgerinteger
Field representing the start ledger index of the query range in Ledger mode.
toLedgerinteger
Field representing the end ledger index of the query range in Ledger mode.
Array containing detailed information for each sender in the transaction. Each object includes the sender's address, amount sent, and sender index.
indexintegerrequired
Index of the sender; uniquely identifies the sender in the transaction. Starts at 0; assigned sequentially when multiple senders exist.
addressstringrequired
Address of the sender. The address used by the sender to send Bitcoin in the transaction; follows P2PKH, P2SH, Bech32, or Bech32m format.
valuestringrequired
Amount sent by the sender in the transaction, displayed in BTC units. Amount allows up to 8 decimal places.
Array containing detailed information for each recipient in the transaction. Each object includes the recipient's address, amount received, and recipient index.
indexintegerrequired
Index of the recipient; uniquely identifies the recipient in the transaction. Starts at 0; assigned sequentially when multiple recipients exist.
addressstringrequired
Address of the recipient. The address used by the recipient to receive Bitcoin; follows P2PKH, P2SH, Bech32, or Bech32m format.
valuestringrequired
Amount received by the recipient in the transaction, displayed in BTC units. Amount allows up to 8 decimal places.
feestringrequired
Transaction fee; the amount paid by the sender to include the transaction in the blockchain network. Amount is displayed in BTC units.
transactionHashstringrequired
Unique hash value of the transaction. A 64-character hexadecimal string generated from transaction data; uniquely identifies the transaction.
transactionIdstringrequired
Unique ID of the transaction. A value that uniquely identifies each transaction; displayed as a 64-character hexadecimal string.
blockHeightintegerrequired
Indicates the height of the block containing the transaction. Integer value representing the order in the blockchain.
blockHashstringrequired
Unique hash value of the block containing the transaction. A 64-character hexadecimal string generated using the SHA-256 algorithm; uniquely identifies the block.
blockTimestampintegerrequired
Creation time of the block containing the transaction. Value in UNIX timestamp format; represents when the block was created in UTC, in seconds.
codestringrequired
Code identifying the cause of the failed request.
messagestringrequired
Detailed message including the name and value of the invalid parameter.
{
  "code": "MISSING_REQUIRED_PARAMETER",
  "message": "Missing required parameter: { PARAMETER_NAME }"
}
cURL
curl -X POST 'https://web3.nodit.io/v1/bitcoin/mainnet/native/getNativeTokenTransfersByAccount' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo' \
  -d '{
    "accountAddress": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq",
    "relation": "from",
    "fromDate": "2025-01-01T00:00:00+00:00",
    "toDate": "2025-01-31T00:00:00+00:00",
    "page": 1,
    "rpp": 10
  }'