API Reference

SimpleHash Platform Overview

Currently live on 70+ chains and testnets

Welcome!

SimpleHash is a platform that provides access to Token balances, DEX prices, and transfers, along with NFT metadata, media, collection details, sales, floor prices, listings and bids across multiple chains.

If you'd like to skip ahead and just try out some of the endpoints, try one out here by using the example curl widget on the page

Example queries and responses are shown for each endpoint listed in the menu, and can be tested with the request widget on the right of each endpoint page.

SimpleHash is built by a team with extensive experience in crypto - we're used at production scale by many of the largest names in crypto, including Coinbase, Phantom, Ledger and Zerion.


See what makes us different vs. the competition


Options for accessing the data

We offer three main methods for accessing Token data, depending on your use case:

  • REST API: for general purpose access of Token data - each endpoint is detailed on this API docs site
  • Webhook events: for subscribing to real-time Token events - the set of available events and how to use the webhooks is detailed in this section
  • Bulk access / sync: we also offer a custom data export service for teams with high-performance work loads via flat-files or Kafka streaming - if you'd like to learn more about this option, please email [email protected]

Support

If you need support integrating with the SimpleHash API, please contact [email protected]. For those on paid enterprise plans, we also offer direct VIP Slack or Telegram channel support and technical assistance.


Authentication

All REST API endpoints require use of an API Key - these can be obtained by registering on the developer portal . The key should be passed within the request header in the following format: X-API-KEY: {API_KEY}. For Kafka Streaming Service credentials, please get in touch.


API Domain

The base URLs that can be used for the REST API and webhooks are : https://api.simplehash.com (primary) or https://api.simplehash.xyz (backup). For CDN links, either the .com or .xyz tlds can be used.


Formatting and Variables

  • chains: Specified as the name(s) of the desired chain. The available options are listed here: Supported Chains & Testnets

    • If you have feedback on the chains / networks you'd like to see supported, please contact [email protected].

  • contract_address: Address of the desired contract:

    • EVM chains: Formatted as a hex addresses, e.g., 0x52782699900df91b58ecd618e77847c5774dcd2e. Both the lowercase and checksum cases are supported.
    • Bitcoin: Formatted as a lowercase string corresponding to the inscription ID, e.g. 6fb976ab49dcec017f1e201e84395983204ae1a7c2abf7ced0a85d692e442799i0
    • Solana: Formatted as a Base58-encoded string uniquely representing the token itself, e.g., 2DfTukhzftoX9oF8xaUQ8kS85oPEVEHsmpa4DQiinQGD. These addresses on Solana are often elsewhere referred to as a Mint Address or Token Address. These are case sensitive.
    • Flow: Formatted as a hybrid string starting with with the capital A, followed by a period and the hexidecimal portion of the address, followed by a period and the name of the contract, e.g., A.0b2a3299cc857e29.TopShot. These are case sensitive.

  • token_id: Numeric ID of the specific token (if NFT) on a given contract:

    • EVM chains: A numeric value, e.g., 1002
    • Bitcoin: Does not apply, the contract_address (inscription ID) uniquely identifies the token
    • Solana: Does not apply, the contract_address (mint address) uniquely identifies the token
    • Flow: A numeric value, e.g., 1002

  • wallet_addresses: Address of the desired owner(s):

    • EVM chains: Formatted as hex addresses, e.g., 0xb47902159c61b06ec03770a2cab692901d9a3759. Both the lowercase and checksum cases are supported.
    • Bitcoin: Formatted as Base58-strings, e.g. bc1qv8zhcjzpjw4m4tdyc5zn3dmax0z6rr6l78fevg, 3MggiruZDgJhg7piJEZPBHPfhbeQH1unNF. These are case sensitive.
    • Solana: Formatted as Base58-strings, e.g., Dg3C8UeEnCdZoFqeFCwYCfB96o5Erb6D63rDQJTmuTkW. These are case sensitive.
    • Flow: Formatted as lowercase hex addresses, e.g., 0x10285e5afddd80c3

Pagination & Cursors

REST API endpoints that return multiple items are paginated using a cursor system. To pull the next set of results, query the next field returned in the current results, e.g., <https://api.simplehash.com/api/v0/nfts?chains=optimism&cursor=cD0weDAwNmViNjEzYM...a23D>



Base Ecosystem Program

SimpleHash is becoming even more Based. As of today, any crypto developer can sign up for the Base Ecosystem Program - which provides complimentary access to a SimpleHash enterprise plan when using Base queries, including direct VIP support. We are excited to continue to make it easier to build on one of the most exciting onchain ecosystems and to power the next wave of Token-enabled apps.

For full details, and to get started, simply message [email protected] and we'll get you enrolled.