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.
3. Browse and Select Plan
To decide on a suitable plan by gauging requests required by your project size and user needs.
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.
4. Payment
Before you set up your keys, you will need to make the payment upfront via Sphere.
- Redirected to Sphere payment page.
- Enter the required details.
- Connect wallet to pay via Solana blockchain
- Click the Subscribe button to proceed.
New payment methods is a work in progress.
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 be your wallet delegated to be billed every month, while 0.2 USDC is to be paid upon signing.
If your delegated wallet has insufficient funds to pay for the month, your API Key will be disregarded, and your requests will fallback as a typical call via the free plan.
5. Processing Screen
Yes, please wait.
6. Setup API Keys
Click on the "+ Generate Key" button to generate an API Key.
The rate limits are imposed on a PER USER basis, not per API Key.
If you need more requests, you can upgrade the plan, or create a completely new account and re-subscribe, which creates 2 separate plans.
7. Have a Question?
Please reach out to us
- If you need have increasing demand and growth in your app.
- 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 the other endpoints to build world class applications.
If you are new to development, do take a look at
Dive right in!