Skip to content

README.md

Latest commit

 

History

History
56 lines (32 loc) · 2.26 KB

README.md

File metadata and controls

56 lines (32 loc) · 2.26 KB

API

Blockscout Internal Documentation

To view Modules and API Reference documentation:

  1. Generate documentation.

    mix docs

  2. View the generated docs.

    open doc/index.html

Blockscout API Usage

API calls can be accessed from the Blockscout main menu, footer or header depending on the instance.

Blockscout supports several methods:

  1. REST API: API that serves the UI for new instances of Blockscout. Methods available here: https://eth.blockscout.com/api-docs
  2. Graphiql: An IDE for exploring GraphQL.
  3. RPC API: provided for developers transitioning their applications from Etherscan to Blockscout. Supports GET and POST requests.
    1. Typically located at https://blockscout.com/instance/networktype/api-docs.
    2. For example, Ethereum mainnet docs are located at https://blockscout.com/eth/mainnet/api-docs
  4. Eth RPC API: Supports the most popular JSON RPC methods.

API access in new instance

APIs in header menu

API links in the footer

GraphQL

Send Queries to quickly get information. Use the Docs button to quickly find arguments accepted by the schema. More information is available in our Blockscout GraphQL tutorial.

Docs button for GraphQL

ETH RPC

Blockscout supports the following methods. Requests and return data are identical to the Ethereum documentation.

  • eth_blockNumber
  • eth_getBalance
  • eth_getLogs

More details on ETH RPC for Blockscout are available here.

API Keys

If My Account is enabled, users can add up to 3 API keys to ensure 50 request/second limits. When API Keys are not used, the global default is 50 requests/second.