GET
/
api
/
v1
/
developer
/
bitcoin
/
ordinals
/
token-transfers
Get Ordinals Token Transfers
curl --request GET \
  --url https://api.allium.so/api/v1/developer/bitcoin/ordinals/token-transfers \
  --header 'X-API-KEY: <api-key>'
{
  "items": [
    {
      "inscription_id": "<string>",
      "deployment_id": "<string>",
      "from_address": "<string>",
      "from_overall_balance_pre": "<string>",
      "from_overall_balance_post": "<string>",
      "from_available_balance_pre": "<string>",
      "from_available_balance_post": "<string>",
      "to_address": "<string>",
      "to_overall_balance_pre": "<string>",
      "to_overall_balance_post": "<string>",
      "to_available_balance_pre": "<string>",
      "to_available_balance_post": "<string>",
      "amount": "<string>",
      "token_tick": "<string>",
      "token_type": "<string>",
      "token_max": "<string>",
      "token_lim": "<string>",
      "token_dec": -1,
      "token_op": "<string>",
      "token_amt": "<string>",
      "token_minted": "<string>",
      "token_transfer_type": "<string>",
      "pseudo_offset_order": 0,
      "sat_tx_offset": 0,
      "error": "<string>",
      "is_valid": true,
      "block_timestamp": "2023-11-07T05:31:56Z",
      "transaction_hash": "<string>",
      "transaction_index": -1,
      "block_number": 0,
      "block_hash": "<string>"
    }
  ],
  "size": 2,
  "page": 2
}

Ordinals token transfers on Bitcoin can include BRC-20 balance changes by inscribing satoshis with metadata that represents token amounts. When these inscribed tokens are transferred, the BRC-20 balance is updated accordingly, reflecting changes in token ownership. Each transfer modifies the token’s ledger state while maintaining a history of all transactions on-chain, enabling fungible token transfers alongside the unique ordinal inscriptions within Bitcoin ecosystem.

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
chain
enum<string>
required
Available options:
abstract,
aleph_zero,
alienx,
apechain,
aptos,
arbitrum,
arbitrum_nova,
arbitrum_sepolia,
astar,
avalanche,
b3,
base,
base_sepolia,
beacon,
beacon_validators,
berachain,
binance,
bitcoin,
blast,
bsc,
celo,
cosmos,
cosmoshub,
ethereum,
stellar,
ethereum_goerli,
fantom,
xrp_ledger,
vana,
dydx,
ethereum_sepolia,
kava,
bitcoin_cash,
celestia,
codex,
litecoin,
mantra,
dymension,
babylon,
ethereum_hoodi,
winr,
sx,
injective,
educhain,
dogecoin,
hyperevm,
hyperliquid,
everclear,
fraxtal,
gnosis,
gravity,
harmony,
hedera,
holesky,
imx_zkevm,
ink,
kinto,
linea,
manta_pacific,
mantle,
metis,
mode,
monad_devnet1,
monad_testnet,
near,
oasys,
optimism,
osmosis,
polygon,
polygon_zkevm,
proof_of_play_apex,
proof_of_play_boss,
provenance,
real,
reya,
ronin,
rootstock,
sanko,
scroll,
scroll_sepolia,
sei,
solana,
soneium,
sonic,
stacks,
starknet,
superposition,
sui,
ton,
tron,
unichain,
worldchain,
zksync,
zora
​
block_number
string

Response

200
application/json

Successful Response

The response is of type object.