Getting Started

This guide will get you all set up and ready to use the Aori API. We'll cover how to get started using one of our SDK's and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of the Execution API.

Introduction

Choosing your Client

Before making your first API request, you need to pick which API client you will use.

# Install the TypeScript SDK
npm install @aori-io/aori-ts --save

The recommended way to interact with the Aori API is by using one of our SDKs. Today, Aori offers fine-tuned Typescript and Rust libraries to make your integration as easy as possible and give you the best experience when interacting with Aori.

API Key Authentication

While the Aori API doesn't require authentication for basic usage, we recommend obtaining an API key from the Aori Developer Portal for enhanced tracking and analytics.

const apiKey = process.env.AORI_API_KEY;

// Include API key in any request
const quote = await getQuote(quoteRequest, 'https://api.aori.io', apiKey);
const swap = await submitSwap(swapRequest, 'https://api.aori.io', apiKey);

Making your first API request

After picking your preferred client, you are ready to make your first call to Aori. Let's start by checking the API health status.

curl https://api.aori.io/health

{
  "status": "ok"
}

What's next?

Great, now you're set up with the Aori SDK and have made your first request. Here's concepts to explore next to build powerful cross-chain applications: