API Reference

Migrating from V1

📘

Questions?

Reach out via Slack or email and we can assist and schedule a call to walk you through the migration if needed

Timeline

  • April 1st 2024:
    • Release of Figment API V2
  • April 30th 2025:
    • Deprecation of:
      • Rewards API V1
      • DOT proxy V1
      • ETH Staking Flows API
      • ETH Validators API V1

For all endpoints

  • All our endpoints are on the same base URL https://api.figment.io
  • All endpoints require the API keys to be sent in the x-api-key header
  • We no longer use numeric IDs, only strings

Rewards API

ETH Rewards

  • V1 Endpoint -> V2 Endpoint
  • The endpoint URL has changed:
    • V1: https://eth-rewards.datahub.figment.io/v2/rewards
    • V2: https://api.figment.io/ethereum/rewards
  • You don’t need to pass validator pubkeys anymore. The endpoint knows which accounts you track and returns rewards for those.
  • The endpoint’s pagination uses our new API standard: page’s size and number.
  • The following field have been renamed:
    • The parameter aggregation is renamed to time_rollup
    • The parameter chain_id is renamed to network
    • The response field validator is renamed to pubkey
    • The response meta field network is renamed to protocol
    • The response’s rewards types staking and tips are renamed to consensus and execution
    • The response field mev_service is renamed to mev_relay

ETH Organization Rewards

  • V1 endpoint -> V2 endpoint
  • The endpoint URL has changed:
    • V1 URL: https://rewards.datahub.figment.io/v3/rewards/ethereum/validator_addresses
      V2 URL: https://api.figment.io/ethereum/validators
  • The parameter chain_id is renamed to network
  • The response field id is renamed to pubkey
  • The response’s rewards types staking and tips are renamed to consensus and execution
  • The response field type is gone
  • The endpoint’s pagination uses our new API standard: page’s size and number.

ETH Withdrawals

  • V1 Endpoint -> V2 Endpoint
  • The endpoint URL has changed:
    • V1 URL: https://eth-rewards.datahub.figment.io/v2/withdrawals
    • V2 URL: https://api.figment.io/ethereum/withdrawals
  • The response field validator_public_key is renamed to pubkey

ETH Reward Rates

  • V1 Endpoint -> V2 Endpoint
  • The endpoint URL has changed:
    • V1 URL: https://eth-rewards.datahub.figment.io/rates
    • V2 URL: https://api.figment.io/ethereum/rewards_rates
  • The response is included within a data key
  • The response’s rewards types staking and tips are renamed to consensus and execution

ETH Network Overview

  • V1 endpoint -> V2 endpoint
  • The endpoint URL has changed:
    • V1 URL: https://eth-network.datahub.figment.io/v3/ethereum/network_overview
    • V2 URL: https://api.figment.io/ethereum/network_estimates
  • The query param chain_id is renamed to network
  • The response is included within a data key

SOL Rewards

  • V1 Endpoint -> V2 Endpoint
  • The endpoint URL has changed:
    • V1 URL: https://solana-rewards.datahub.figment.io/v2/rewards
    • V2 URL: https://api.figment.io/solana/rewards
  • You don’t need to pass system or staking accounts anymore. The endpoint knows which accounts you track and returns rewards for those.
  • The query param chain_id is renamed to network
  • The response is included within a data key
  • The response meta field network is renamed to protocol

SOL Rewards Rates

  • V1 Endpoint -> V2 Endpoint
  • The endpoint URL has changed:
    • V1 URL: https://solana-rewards.datahub.figment.io/rates
    • V2 URL: https://api.figment.io/solana/rewards_rates

DOT Rewards

  • V1 Endpoint -> V2 Endpoint
  • The endpoint URL has changed:
    • V1 URL: https://polkadot-rewards.datahub.figment.io/v2/rewards
    • V2 URL: https://api.figment.io/polkadot/rewards
  • The query param chain_id is renamed to network
  • The response is included within a data key
  • The response meta field network is renamed to protocol

DOT Reward Rates

  • V1 Endpoint -> V2 Endpoint
  • The endpoint URL has changed:
    • V1 URL: https://polkadot-rewards.datahub.figment.io/rates
    • V2 URL: https://api.figment.io/polkadot/rewards_rates

NEAR Rewards

  • V1 Endpoint -> V2 Endpoint
  • The endpoint URL has changed:
    • V1 URL: https://near-rewards.datahub.figment.io/rates
    • V2 URL: https://api.figment.io/near/rewards_rates
  • The request parameter accounts is renamed delegator_addresses
  • The request parameter aggregation is renamed time_rollup
  • The response field accounts is renamed to delegator_address

ATOM Rewards

  • V1 Endpoint -> V2 Endpoint
  • The endpoint URL has changed:
    • V1 URL: https://cosmos-rewards.datahub.figment.io/rates
    • V2 URL: https://api.figment.io/cosmos/rewards_rates
  • The request parameter accounts is renamed delegator_addresses
  • The response field accounts is renamed to delegator_address

ADA Rewards

  • V1 Endpoint -> V2 Endpoint
  • The endpoint URL has changed:
    • V1 URL: https://cardano-rewards.datahub.figment.io/v2/rewards
    • V2 URL: https://api.figment.io/cardano/rewards
  • In the request, accounts is renamed to delegator_addresses
  • In the response accounts is renamed to delegator_addresses
  • In the response, period is renamed to epoch

MATIC Rewards

  • V1 Endpoint -> V2 Endpoint
  • The endpoint URL has changed:
    • V1 URL: https://matic-rewards.datahub.figment.io/v2/rewards
    • V2 URL: https://api.figment.io/polygon/rewards
  • In the request, accounts is renamed to delegator_addresses
  • In the response accounts is renamed to delegator_address
  • In the response, period is renamed to checkpoint

Legacy Staking API (Flows)

ETH Aggregated Staking and Unstaking

We're deprecating our ETH Aggregated Staking and ETH Aggregated Unstaking flows. All features are available through our other Ethereum RESTful endpoints:

Staking Flows (Create)

  • The endpoint URL has changed:
    • V1 URL: https://{network}-slate.datahub.figment.io/api/v1/flows
    • V2 URL: https://api.figment.io/flows

Staking Flows (Next)

  • The endpoint URL has changed:
    • V1 URL: https://{network}-slate.datahub.figment.io/api/v1/flows/[:flow_id]/next
    • V2 URL: https://api.figment.io/flows/[:flow_id]/next

Polkadot Proxy

DOT Add Nomination Proxy

  • The endpoint URL has changed:
    • V1 URL: https://hubble.figment.io/api/v1/prime/polkadot/nomination_proxy
    • V2 URL: https://api.figment.io/polkadot/nomination_proxy

DOT Revoke Nomination Proxy

  • The endpoint URL has changed:
    • V1 URL: https://hubble.figment.io/api/v1/prime/polkadot/nomination_proxy/revoke_proxy
    • V2 URL: https://api.figment.io/polkadot/nomination_proxy/revoke_proxy

ETH Validators API

Provision Validators

  • V1 Endpoint -> V2 Endpoint
  • The URL has changed:
    • V1 URL: https://hubble.figment.io/api/v1/prime/eth2_staking/provision
    • V2 URL: https://api.figment.io/ethereum/validators
  • Before: /provision allowed you to create validator public keys in an asynchronous way: it didn’t return the validators data in the response and you needed to poll Get Validators and then call Build Funding Transaction to get a staking transaction for validators.
  • Now: Creating validators and generating a staking transaction to fund them are now merged into one synchronous endpoint: Create Validators.
  • The parameter eth2_network_name is renamed to network

Build Funding Transaction

  • V1 Endpoint
  • This endpoint is not present in the API V2.
  • Before: This endpoint allowed you to get a staking transaction to fund N validators that had previously been provisionedusing the Provision Validators endpoint. This was a two step process
  • Now: Creating validators and generating a staking transaction to fund them are now merged into one synchronous endpoint: Create Validators.

ETH Get Validators

  • The URL has changed:
    • V1 URL: https://hubble.figment.io/api/v1/prime/eth2_staking/validators
    • V2 URL: https://api.figment.io/ethereum/validators
  • The parameter eth2_network_name is now network
  • The response field presigned_exit_transaction is now an object called exit_message
  • Request additional metadata (status history, deposit data, exit message, etc) is now handled with the include_fields parameter.
  • Validator metadata in the repsonse is now nested directly in the parent data object instead of data.attributes
  • Response field meta object in V2 gives you pagination info