Unified transfers

Heimdahl.xyz REST API Transfer Tutorial

This tutorial demonstrates how to use our Transfers REST API to retrieve token transfer data across different blockchains, networks, and addresses.

API Endpoint

https://api.heimdahl.xyz/v1/transfers/list/{path}

Note: This API requires authentication using a Bearer token.

Path Format

The path follows one of these two patterns:

1. {chain}.{network}.{token}.{from}.{to}.all

2. {chain}.{network}.{token}.{wallet}.all

Where:

• chain: Blockchain (ethereum, polygon, base, binance, solana, arbitrum, tron)

• network: Network type (mainnet, testnet, goerli, etc.)

• token: Token symbol (USDT, USDC, WETH, etc.)

• from: Sender address (0x...)

• to: Recipient address (0x...)

• wallet: Single wallet to query (either as sender or receiver)

• The final parameter is currently set to all which is reserved for filter by amount bucket it belonss to (small, large or whale depending on particular tokens circulating supply)

Example Usage

Basic command structure

Bash

curl -H "Authorization: Bearer YOUR_API_KEY" "https://api.heimdahl.xyz/v1/transfers/list/{path}"

CLI

heimdahl transfer list {chain}.{network}.{token}.{from}.{to}.{size}

Examples by Chain and Token

USDC Examples

Ethereum

Bash

# Get all USDC transfers from a specific address on Polygon mainnet
curl -H "Authorization: Bearer YOUR_API_KEY" "https://api.heimdahl.xyz/v1/transfers/list/ethereum.mainnet.usdc.0x7ceb23fd6bc0add59e62ac25578270cff1b9f619.all.all" | jq

# Get all USDC transfers between two addresses on Polygon mainnet
curl -H "Authorization: Bearer YOUR_API_KEY" "https://api.heimdahl.xyz/v1/transfers/list/ethereum.mainnet.usdc.0x7ceb23fd6bc0add59e62ac25578270cff1b9f619.0x2791bca1f2de4661ed88a30c99a7a9449aa84174.all" | jq

CLI

# Get all USDC transfers from a specific address on ethereum mainnet
heimdahl transfer list ethereum.mainnet.usdc.0x7ceb23fd6bc0add59e62ac25578270cff1b9f619.all.all --format=json (or csv, or table)

# Get all USDC transfers between two addresses on ethereum mainnet
heimdahl transfer list ethereum.mainnet.usdc.0x7ceb23fd6bc0add59e62ac25578270cff1b9f619.0x2791bca1f2de4661ed88a30c99a7a9449aa84174.all --format=table

Path Format Note

The current version of the API uses all for the transfer size bucket parameter:

• All paths end with .all to indicate all transfer sizes

Response Format

The API returns transfer data in JSON format. Each transfer contains the following information:

{
  "timestamp": 1740844573,
  "from_address": "0xEcd7Eef15713997528896Cb5db7ec316Db4C2101",
  "to_address": "0x39F5b252dE249790fAEd0C2F05aBead56D2088e1",
  "amount": 1.29e+18,
  "token_address": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
  "symbol": "WETH",
  "chain": "ethereum",
  "network": "mainnet",
  "tx_hash": "0x54180d7f37159043b2221f22c4479742a32cb86d72a17a6a9efccef3288e1e56",
  "decimals": 18,
  "position": 21953050
}

The response includes these key fields:

• timestamp: Unix timestamp of the transfer

• from_address: Sender address

• to_address: Recipient address

• amount: Transfer amount (in token units)

• token_address: Address of the token contract

• symbol: Token symbol (USDC, USDT, WETH, etc.)

• chain: Blockchain

• network: Network type (mainnet, testnet, etc.)

• tx_hash: Transaction hash

• decimals: Number of decimal places the token uses

• position: Block position