Tracking Addresses For Reporting

This endpoint enables programmatic tracking of addresses/fees for reporting purposes and aims to replace the manually processes of generating/exchanging/processing of Google Sheets.

Supports 54 protocols (see protocol enum in OpenAPI spec for values).

Protocol-specific nuances

• ETH pass a withdrawal address
• SOL pass a stake authority
• ADA pass stake key

The fee_percentage field is for custodians. Ignore otherwise.

The recommended implementation plan is to call it after an onchain confirmation of a successful staking transaction.

Mainnet only.

⚠️ Once you call this endpoint, it may take up to an hour for those addresses to show up via our API.

Parameters

protocol

• Type: string
• Enum: Required
• Values:
  agoricaleo, algorand, aptos, audius, avalanche, axelar, babylon, band, berachain, bnb, cardano, casper, celestia, celo, concordium, core, cosmos, cronos, dydx, eigen_layer, ethereum, flow, hyperliquid, initia, injective, iotaku, samalido, liquid_collective_eth, livepeer, lombard, mantra, minamon, monad, moonbeam, multiversx, namada, near, opentrade_eth, osmosis, polkadot, polygon, provenances, seiskale, solana, stacks, starknet, story, suit, he_grapht, towns, vault, awemix, zamazero_gravity, zeta_chain

address

• Type: string
• Required: The account address.

fee_percentage

• Type: number
• Description: The gross effective fee for this account as a decimal.

Response Status Codes

• 201 Address created
• 400 Bad request
• 401 Unauthorized
• 422 Unprocessable content

Example Request

curl --request POST \
     --url https://api.figment.io/addresses \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: your-api-key-here' \
     --data '\
{\
  "protocol": "agoric"\
}\
'```

### Example Response

```json
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "protocol": "solana",
    "network": "mainnet",
    "address": "3ydf2egwcsjvigdqagtcajfcdjayzs4wklxokgerfb8j"
  }
}