Skip to content
This repository has been archived by the owner on Oct 3, 2024. It is now read-only.

Commit

Permalink
Add block explorer api sidebar (#772)
Browse files Browse the repository at this point in the history
* fix: firebase source to redirect at github link tutorial

* docs: add the blockexplorer api docs

* docs: add block explorer api on the sidebar

* Update firebase.json

---------

Co-authored-by: Roman Petriv <[email protected]>
  • Loading branch information
AlbionaHoti and Romsters authored Oct 31, 2023
1 parent d533da3 commit cc0a5a9
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/.vuepress/sidebar/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ export const enSidebar = sidebar({
{
text: "Block Explorer", // required
link: "/tools/block-explorer", // optional, which should be a absolute path.
children: ["/tools/block-explorer/block-explorer-menu", "/tools/block-explorer/contract-verification"],
children: ["/tools/block-explorer/block-explorer-menu", "/tools/block-explorer/contract-verification", "/tools/block-explorer/block-explorer-api"],
},
],
});
4 changes: 4 additions & 0 deletions docs/tools/block-explorer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,7 @@ Use the search bar on all pages to access data by:
- **Batch index**: The index of a batch submitted to L1.
- **Contract address**: The callable address of a smart contract deployed on zkSync Era.
- **Transaction hash**: The unique 66 character identifier of an executed transaction.

## Block Explorer API

The [zkSync Era Block Explorer API](https://block-explorer-api.mainnet.zksync.io/docs) is available for developers to access data directly via HTTP requests. Learn more [here](./block-explorer-api.md).
31 changes: 31 additions & 0 deletions docs/tools/block-explorer/block-explorer-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
head:
- - meta
- name: "twitter:title"
content: Block Explorer API | zkSync Era Docs
---

# Block Explorer API

We’ve developed the [zkSync Era Block Explorer API](https://block-explorer-api.mainnet.zksync.io/docs) for developers to access [zkSync Era Block Explorer](https://explorer.zksync.io/) data directly via HTTP requests.

The [API](https://block-explorer-api.mainnet.zksync.io/docs) provides various endpoints for many use cases you might want in your app. It is compatible with [Etherscan API](https://docs.etherscan.io/), which makes it easy to transition your existing apps to zkSync Era network.

The following modules are supported:

- [Contract](https://block-explorer-api.mainnet.zksync.io/docs#/Contract%20API)
- [Account](https://block-explorer-api.mainnet.zksync.io/docs#/Account%20API)
- [Transaction](https://block-explorer-api.mainnet.zksync.io/docs#/Transaction%20API)
- [Logs](https://block-explorer-api.mainnet.zksync.io/docs#/Logs%20API)
- [Block](https://block-explorer-api.mainnet.zksync.io/docs#/Block%20API)

Check out the API documentation [API docs on Mainnet](https://block-explorer-api.mainnet.zksync.io/docs) | [API docs on Testnet](https://block-explorer-api.testnets.zksync.dev/docs)

:::note Note

The [API](https://block-explorer-api.mainnet.zksync.io/docs) does not fully cover all the functionality yet.
:::

We are working on additional endpoints to cover more use cases and to make developers’ experience better. Stay tuned for further updates.

Feel free to contribute and create issues and feature requests in [zkSync Era Block Explorer GitHub repo](https://github.com/matter-labs/block-explorer).

0 comments on commit cc0a5a9

Please sign in to comment.