For the complete documentation index, see llms.txt. This page is also available as Markdown.

๐ŸŒEkubo API

The API that powers Ekubo's websites

The API URL is hosted at the following URL:

https://prod-api.ekubo.org

It contains data for all the chains that we are deployed to and index. It also hosts an OpenAPI 3.1 document that self-describes all the endpoints.

API Architecture

Our API functionality is based entirely on querying the Postgres schema kept up-to-date by the open-source indexer repository (GitHub). You can replicate all of the API functionality by simply running your own instance of the Indexer and querying the your own Postgres database. Much of the API functionality is conveniently contained in views and scheduled jobs allowing you to easily replicate all the functionalities of our API.

Caching

There are multiple layers of caching with varying TTL between the database and the client. If you have specific latency requirements or need to make a large number of requests per second, it's best to run your own indexer.

Rate limiting

We have a rate limiting web application firewall (WAF) in front of the API. If you would like to make calls in excess of the limit, please reach out on Discord to find a solution. The rate limit is not fixed and we can change it as necessary to control costs or ensure fair access to all users. Generally we will not create exceptions for you to exceed our public API rate limits.

Endpoints

Every endpoint is browsable and testable on the Endpoints page, which renders the OpenAPI specification interactively โ€” including sending requests to the live API.

The endpoints are documented via OpenAPI 3.1 at the /openapi.json endpoint. The URL is https://prod-api.ekubo.org/openapi.json, which can also be imported into REST clients like Postman.

Last updated

Was this helpful?