Network APIs
  • 08 Dec 2023
  • 1 Minute to read
  • Dark
  • PDF

Network APIs

  • Dark
  • PDF

Article Summary

Main APIs

Radix currently offers a couple of key APIs, targeted to different use cases.

Core API

The Core API is the main Radix API exposed by Radix nodes. It is predominantly intended as a private API. The Core API is not exposed publicly by the Radix Foundation, and users needing a Core API will need to run their own node, or use an RPC Provider.

The Core API provides low-level and high-level abstractions, and includes:

  • The long-term support “LTS” sub-api, designed for financial integrators.

  • Access to the current ledger state

  • Access to a transaction stream, transaction status and submission capabilities.

The full documentation for the Core API is available on ReDocly.

Gateway API

The Gateway API is exposed by the Network Gateway. The Radix Foundation runs an IP rate-limited Gateway API, the Foundation Gateway.

The Gateway API provides low-level and high-level abstractions, but is primarily intended for use by dApp website frontends and general network clients like dashboards. It can be used for:

  • Reading the state of accounts or other components

  • High-level transaction information

  • Queries of historic ledger state

The full documentation for the Gateway API is available on ReDocly.

The Foundation Gateway’s IP-based rate limits are designed to enable a standard user to engage with the Radix ecosystem. For example, a user using their wallet, browsing a front-end dApp website (with a relatively light request burden, think no more than ~40 requests per page load) and using a connect button on that site. Front-end dApps will need to use the Gateway responsibly to maintain a good user experience. If you are building a back-end with large or user-driven request profiles, you will need to run your own Node/Core API or Gateway.

The rate-limited Foundation Gateway is available at:

Other APIs

Radix Nodes also expose the System API, which can be used for debugging the node. Its documentation is available on ReDocly here.

Was this article helpful?