# Olympex

> Build with Olympex: the REST API for aggregated swap quotes, transaction calldata, and cross-chain routing across EVM chains.

- [Introduction](https://docs.olympex.io/get-started/introduction.md): The Olympex REST API returns aggregated swap quotes and unsigned calldata, tracks cross-chain transfers, runs limit orders and DCA strategies, and lists the chains and tokens it supports.
- [Why Olympex](https://docs.olympex.io/get-started/why-olympex.md): Aggregated liquidity, cross-chain routes, limit orders, DCA strategies and integrator fees on EVM chains, behind one signed REST API.
- [Quickstart](https://docs.olympex.io/get-started/quickstart.md): Create a test API key and send your first signed requests to the Olympex REST API in minutes.
- [Create a test API key](https://docs.olympex.io/get-started/create-an-api-key.md): Create Olympex API credentials in one click, store them safely, and learn what a test key can and can't do.
- [How Olympex works](https://docs.olympex.io/concepts/how-olympex-works.md): The request lifecycle from quote to settlement, and from order to execution: what the Olympex API does, what your application does, and where funds move.
- [Aggregation and routing](https://docs.olympex.io/concepts/aggregation-and-routing.md): Which liquidity sources Olympex queries, how it picks the winning route, and how to read and fall back from the route it returns.
- [Cross-chain mechanics](https://docs.olympex.io/concepts/cross-chain-mechanics.md): How a cross-chain transfer is quoted, built, sent and tracked: providers, bridges, swaps around the bridge, and status.
- [Slippage and price impact](https://docs.olympex.io/concepts/slippage-and-price-impact.md): Price impact is what your trade size costs against the available liquidity. Slippage is how far you let the price move before the transaction reverts.
- [Gas and fees](https://docs.olympex.io/concepts/gas-and-fees.md): What a swap costs: gas paid to the chain, the gas fields the API returns and how far to trust them, and the integrator fee you can charge. Plus how limit orders and DCA reimburse the execution gas.
- [Supported chains and tokens](https://docs.olympex.io/concepts/supported-chains.md): The chains Olympex supports, how to read the enabled chains and token lists at runtime, where limit orders and DCA run, and how to send chain IDs, token addresses and amounts.
- [Limit orders](https://docs.olympex.io/concepts/limit-orders.md): How limit orders work: what an order sells, how priceTrigger is expressed, the order lifecycle, what can't be sold, and how the execution gas is paid.
- [DCA strategies](https://docs.olympex.io/concepts/dca.md): How DCA works: a strategy and the orders Olympex creates from it, units, the amount of each order, price bounds, the lifecycle, cancelling, and how the execution gas is paid.
- [Order signatures and allowances](https://docs.olympex.io/concepts/order-authorization.md): How a maker authorizes Olympex to execute limit orders and DCA strategies: the pair signature, what it does and doesn't cover, the allowance that limits it, and the order contract on each chain.
- [Security model](https://docs.olympex.io/concepts/security-model.md): What Olympex can and can't do with your funds and credentials, how requests are authenticated, and what your integration is responsible for.
- [Authentication overview](https://docs.olympex.io/authentication/overview.md): Which endpoints are public, which are signed, and the three credentials and four headers a signed request needs.
- [Credentials](https://docs.olympex.io/authentication/credentials.md): The API key ID, secret key and passphrase: what each one does, how Olympex stores it, and how to keep it safe.
- [Sign requests](https://docs.olympex.io/authentication/sign-requests.md): The signing algorithm for Olympex signed endpoints, with reference implementations, known-answer vectors and troubleshooting.
- [Errors and retries](https://docs.olympex.io/authentication/errors-and-retries.md): The response envelope, every error code, gateway responses, and which failures to retry.
- [Limits](https://docs.olympex.io/authentication/limits.md): The timestamp window, nonce reuse, gateway timeout, calldata expiry, order allowances and value ranges your integration has to respect.
- [Get a swap quote](https://docs.olympex.io/guides/get-a-swap-quote.md): Quote a single-chain swap, convert the output to display units, add a gas estimate and keep fallback liquidity sources for the swap.
- [Execute a swap](https://docs.olympex.io/guides/execute-a-swap.md): Build calldata with POST /swap, approve the exact amount, estimate gas and send a single-chain swap from the user's wallet.
- [Cross-chain swap end-to-end](https://docs.olympex.io/guides/cross-chain-swap-end-to-end.md): Check chain support, quote a route, build and send the source transaction, and track the transfer until it lands.
- [Track a swap to finality](https://docs.olympex.io/guides/track-a-swap-to-finality.md): Confirm single-chain swaps from the transaction receipt, read from your RPC or from Olympex, and poll cross-chain transfers with POST /tx-status until they succeed or fail.
- [Place a limit order](https://docs.olympex.io/guides/create-a-limit-order.md): Resolve the tokens, estimate the execution fee, approve the Olympex order contract, sign the token pair, create a limit order, follow it and cancel it.
- [Run a DCA strategy](https://docs.olympex.io/guides/build-a-dca-strategy.md): Approve the Olympex order contract, sign the token pair, create a DCA strategy, follow its orders, then cancel it and lower the allowance.
- [Handle errors and retries](https://docs.olympex.io/guides/handle-errors-and-retries.md): Tell gateway errors from API errors, retry only what is safe to repeat, sign every attempt again, reconcile failed creates, and log the request ID.
- [Going to production](https://docs.olympex.io/guides/going-to-production.md): The pre-launch checklist for an Olympex integration: credentials, signing, swap execution, limit orders and DCA, tracking, fees, monitoring and rollout.
- [API reference overview](https://docs.olympex.io/api-reference/overview.md): The Olympex REST API on one page: base URL, endpoints, response envelope, authentication, the API console, the OpenAPI spec and versioning.
- [API console](https://docs.olympex.io/api-reference/console.md): Sign and send requests to every signed Olympex endpoint from your browser, inspect every signing value, and create a test API key.
- [API conventions](https://docs.olympex.io/api-reference/conventions.md): Wire-format rules shared by every Olympex endpoint: methods, bodies and signing, the envelope, amounts, addresses, chain IDs, IDs, timestamps, lists, errors, request IDs and forward compatibility.
- [OpenAPI specification](https://docs.olympex.io/api-reference/openapi-spec.md): Download the Olympex OpenAPI 3.0 document, generate a typed client, add request signing to it, and map the data model.
- [Create an account](https://docs.olympex.io/api-reference/accounts/create-account.md): Create an API account and get the API key ID and secret key that sign your requests.
- [Get a quote](https://docs.olympex.io/api-reference/quotes/get-quote.md): Get the best aggregated route for a swap on one chain or across two chains.
- [Build a swap](https://docs.olympex.io/api-reference/swap/build-swap.md): Get unsigned transaction calldata for a quoted route, on one chain or across two chains.
- [Get cross-chain transfer status](https://docs.olympex.io/api-reference/transactions/get-transaction-status.md): Track a cross-chain transfer from the source transaction to delivery on the destination chain.
- [Get on-chain transaction status](https://docs.olympex.io/api-reference/transactions/get-transaction.md): Check whether a transaction you broadcast is pending, succeeded, reverted or unknown, on any enabled chain.
- [List chains](https://docs.olympex.io/api-reference/chains/list-chains.md): List the IDs of the chains Olympex has enabled: the source of truth for which chains to offer.
- [List tokens](https://docs.olympex.io/api-reference/tokens/list-tokens.md): List the tokens Olympex lists on a chain, with each token's address, symbol, decimals and logo.
- [Check chain support](https://docs.olympex.io/api-reference/chains/check-chain-support.md): Check whether Olympex supports a chain, for example when you enable it in your product.
- [List limit orders](https://docs.olympex.io/api-reference/limit-orders/list-limit-orders.md): List the limit orders created with your API key, filtered by status, chain or maker wallet.
- [Create a limit order](https://docs.olympex.io/api-reference/limit-orders/create-limit-order.md): Create an order that sells a token from the maker's wallet when the market reaches your price.
- [Get a limit order](https://docs.olympex.io/api-reference/limit-orders/get-limit-order.md): Read one limit order and poll it to follow its status until it completes, fails or is cancelled.
- [Update a limit order](https://docs.olympex.io/api-reference/limit-orders/update-limit-order.md): Change the limit price, amount, expiry, slippage or gas price of a pending limit order.
- [Cancel a limit order](https://docs.olympex.io/api-reference/limit-orders/cancel-limit-order.md): Cancel a pending limit order, then lower the token allowance if no other order needs it.
- [List DCA strategies](https://docs.olympex.io/api-reference/dca/list-dca-strategies.md): List the DCA strategies created with your API key, each with the orders Olympex has created for it.
- [Create a DCA strategy](https://docs.olympex.io/api-reference/dca/create-dca-strategy.md): Spend a fixed budget in equal orders at a fixed interval to buy a token on one chain.
- [Get a DCA strategy](https://docs.olympex.io/api-reference/dca/get-dca-strategy.md): Read one DCA strategy by ID: its tokens, budget, schedule and status.
- [Update a DCA strategy](https://docs.olympex.io/api-reference/dca/update-dca-strategy.md): Cancel a DCA strategy, or change its price bounds.
- [List a strategy's orders](https://docs.olympex.io/api-reference/dca/list-dca-strategy-orders.md): List the orders Olympex has created for one DCA strategy, oldest first.
- [Get a DCA order](https://docs.olympex.io/api-reference/dca/get-dca-order.md): Read one order of a DCA strategy: its status and, once it executes, the amount bought and the transaction hash.
- [FAQ](https://docs.olympex.io/resources/faq.md): Answers to common questions about Olympex API keys, request signing, quotes, swaps, limit orders, DCA, fees and limits.
- [Glossary](https://docs.olympex.io/resources/glossary.md): Definitions of the terms, fields and credentials used across the Olympex API documentation, in alphabetical order.
- [Brand assets](https://docs.olympex.io/resources/brand-assets.md): Olympex logos, colors, and attribution requirements for integrators.
- [Support](https://docs.olympex.io/resources/support.md): How to contact the Olympex team, what to include in a support request, and how to report a leaked credential or a security issue.
- [API terms of use](https://docs.olympex.io/legal/terms.md): Terms governing your use of the Olympex API.
- [Privacy notice](https://docs.olympex.io/legal/privacy.md): How Olympex handles data when you use the API.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.