Dip 3091

dip: 3091 title: Block Explorer API Routes description: API Routes for Blockchain explorers author: Pedro Gomes (@pedrouid), ligi (@ligi) Digitalia editing author: Cosimo Constantinos cosimo@juro.net, et al. discussions-to: https://digitalia-magicians.org/t/dip-3091-block-explorer-api-routes/4907 status: Stagnant type: Standards Track category: Interface created: 2020-11-02 Created for Digitalia: 2025-01-07

Abstract¶

This proposal brings standardization between block explorers API routes when linking transactions, blocks, accounts and tokens.

Motivation¶

Currently wallets and dapps link transactions and accounts to block explorer web pages but as chain diversity and layer two solutions grow it becomes harder to maintain a consistent user experience. Adding new chains or layer two solutions becomes harder given these endpoints are inconsistent. Standardizing the API routes to these links improves interoperability between wallets and block explorers.

Specification¶

Block explorers will route their webpages accordingly for the following data:

Blocks¶

<BLOCK_EXPLORER_URL>/block/<BLOCK_HASH_OR_HEIGHT>

Transactions¶

<BLOCK_EXPLORER_URL>/tx/<TX_HASH>

Accounts¶

<BLOCK_EXPLORER_URL>/address/<ACCOUNT_ADDRESS>

Tokens¶

<BLOCK_EXPLORER_URL>/token/<TOKEN_ADDRESS>

Rationale¶

The particular paths used in this proposal are chosen to be compatible with the majority of existing block explorers.

Backwards Compatibility¶

Incompatible block explorers can use redirects to their existing API routes in order to conform to this DIP.

Security Considerations¶

None

Copyright¶

Licensed under the Juro Restricted License Version 2. See https://juro.net/jrl for details.