Skip to main content

Getting Started

The Euclid API is designed to facilitate interactions with the Euclid platform, enabling users to perform a variety of actions such as querying data, executing transactions, and more. This documentation aims to provide comprehensive information on how to use the API, including details on available endpoints, request and response formats, and example usages.

The Euclid API is built using GraphQL, a powerful query language for APIs that allows clients to request exactly the data they need. This approach avoids both the problems of over and under-fetching data, while also allowing for a more powerful and flexible Api.

note
  • Before reading these docs and using the API, it is recommended you familiarise yourself with GraphQL by reading the official GraphQL documentation.

In addition to the GraphQL API, Euclid also provides a REST API, a traditional and widely-used approach for accessing web services. The REST API is mostly used to generate transactions that can signed by a wallet and broadcast to chains.

Available Queries​

In the following sections, we will be covering all the available queries for the following:

tip

For each query, you can find an example response if you select the "Open in Playground" link.

  • Chain: Query information related to the chain.
  • Factory: Query information from the factory contract.
  • Router: Query information from the router contract.
  • VLP: Query information from VLP contracts.
  • VCoin: Query information from the Virtual Balance contract.
  • Pool: Get information on Euclid pools such as liquidity and volume.
  • Token: Get token metadata for tokens.
  • CW20: Get information on a CW20 token.

GraphQL Endpoints​

Testnet: https://testnet.api.euclidprotocol.com

REST API​

In addition to the GraphQL API, the Euclid platform also provides a REST API for various operations. Below are the available REST API sections we will cover:

  • Chains: Get information on the list of chains integrated with Euclid.
  • Contracts: Get the list of deployed Euclid contracts.
  • Routes: Get the available routes for a swap.
  • Metadata: Get the price or information on tokens in Euclid pools.
  • Transaction: Generate transactions for various calls such as making swaps and adding/removing liquidity.