Transfers
transfers.query and transfers.subscribe work like trades: transfers.query takes limit, cursor, after_millis and before_millis (HTTP: /transfers), and transfers.subscribe takes history or after_id, with the same results and pushes.
Filters
Section titled “Filters”| Param | Description |
|---|---|
fields |
Required. Transfer fields, or with kind: "transaction", transaction fields |
token |
Transfers of this token, or a list of tokens |
parent |
Instead of token: the tokens directly under an account or a list of them |
sender, receiver |
Transfers and transactions from or to this account |
account |
From or to this account, instead of sender and receiver |
min_amount |
At least this many of the token’s smallest units. Needs token |
kind |
transfer or transaction: only that kind |
include_transactions |
Default false. Transactions alongside transfers when kind isn’t given |
- History (
transfers.query,historyorafter_id) needs asender,receiveroraccount, or atokenwithmin_amount. Subscribing from now on takes any filters, or none for every transfer. - Transactions have no token or amount, so
tokenandmin_amountcan’t be used withinclude_transactionsorkind: "transaction".
Transfer fields
Section titled “Transfer fields”| Field | Type | Description |
|---|---|---|
id |
number | |
kind |
string | transfer or transaction |
height, timestamp_millis |
number | The block it’s in |
transaction_id |
string or null |
null for the few transfers whose transaction started long before they did |
receipt_id |
string or null |
null for transactions |
token |
string or null |
near for native NEAR. null for transactions |
sender |
string or null |
null for a mint |
receiver |
string or null |
null for a burn |
amount |
string or null |
In the token’s smallest units, yoctoNEAR for near. null for transactions |
A transfer is every NEP-141 mint, transfer and burn, and every native NEAR transfer or deposit attached to a function call, except gas refunds and amounts of 1 yoctoNEAR or less.
Transaction fields
Section titled “Transaction fields”With kind: "transaction", fields are a transaction’s: id, height, timestamp_millis, transaction_id, sender and receiver.
A transaction is every transaction, in the block it was included in, whether or not it went on to succeed, so an account’s history can show what it sent alongside the tokens it moved. sender and receiver are its signer and receiver, or for a meta-transaction, those of the delegate action rather than the relayer. Transfers made by a transaction carry its hash as their transaction_id.