Skip to main content

API Setup

Get started by setting up an account on the dashboard to generate API Keys and managing payments via Sphere.

Then, to use the API Key in our APIs, simply add the key to the header.

headers: {
    'Content-Type': 'application/json',
    'x-api-key': '' // enter api key here
},

1. Open Portal​

Navigate to https://portal.jup.ag

2. Connect via email​

To enter the portal, simply connect via email account. This allows us to keep track of your account tagged to your API Keys.

Connect

3. Browse and Select Plan​

To decide on a suitable plan by gauging requests required by your project size and user needs.

Change of plans

You can always change your plans later.

Plan changing by yourself is a work in progress. Please reach out to the team in the meantime.

Plans

4. Payment​

Before you set up your keys, you will need to make the payment upfront via Sphere.

  1. Redirected to Sphere payment page.
  2. Enter the required details.
  3. Connect wallet to pay via Solana blockchain
  4. Click the Subscribe button to proceed.
other payment methods

New payment methods is a work in progress.

Payment delegation

Do note that the Sphere payment is set up as a delegation payment method.

This means that you have delegated the total billable to be deducted/withdrawn from your wallet automatically per month.

For example, in the image, 2.4 USDC is total billable which will mean your wallet will be delegated to be billed every month, while 0.2 USDC is to be paid upfront upon signing.

Out of funds

If your delegated wallet has insufficient funds to pay for the new month, your API Key will be disregarded, and your requests will fallback as a typical call via the free plan.

Payment

5. Processing Screen​

Yes, please wait.

Processing

6. Setup API Keys​

Click on the "+ Generate Key" button to generate an API Key.

Generating multiple keys

The rate limits are imposed on a PER ACCOUNT basis, not per API Key.

If you need more requests, you can upgrade the plan, or create a completely new account and subscribe to a plan, (this means you will have 2 separate accounts, each has its own plans).

Generate

7. Have a Question?​

Please reach out to us.

  • If you have increasing demand and growth in your app, and need additional support.
  • If you have questions or need support.
  • Join the Telegram channel or Discord channel to subsribe to updates.

8. Get Started!​

With your API Key, you can gain higher request access to /quote, /swap and other endpoints to build world class applications.

If you are new to development, do take a look at

Dive right in!