Skip to content

Commit 39f4198

Browse files
0xYankee-Raccoons0xYankee-Raccoons
committed
Merge branch 'main' into mintlify-migration
2 parents 85b8e60 + 6037191 commit 39f4198

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1499
-169
lines changed

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
> This version of documentation will no longer be maintained. We will be using Mintlify moving forward with new docs!
2+
13
# Jupiter Developer Docs
24

35
Welcome to Jupiter Developer Documentation! You'll find detailed API guides, schemas, and powerful tool kits built by the team and DevRel Working Group to help you build with Jupiter.

‎docs/101-ultra-api/3-get-balances.md‎

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,19 @@
11
---
2-
sidebar_label: "Get Balances"
2+
sidebar_label: "Get Balances (Deprecated)"
33
description: "Request for token balances of an account."
4-
title: "Get Balances"
4+
title: "Get Balances (Deprecated)"
55
---
66

77
<head>
8-
<title>Get Balances</title>
8+
<title>Get Balances (Deprecated)</title>
99
<meta name="twitter:card" content="summary" />
1010
</head>
1111

12-
:::note
13-
Lite URL: `https://lite-api.jup.ag/ultra/v1/balances`
14-
Dynamic URL: `https://api.jup.ag/ultra/v1/balances`
15-
16-
Dynamic Rate Limits are now applied to Ultra API.
17-
18-
- No Pro plans or payment needed.
19-
- Simply generate the universal API Key via [Portal](https://portal.jup.ag)
20-
- Rate limits scale together with your swap volume.
21-
22-
[Read more about Ultra API Dynamic Rate Limit](/docs/api-rate-limit).
23-
:::
24-
25-
:::tip API Reference
26-
To fully utilize the Ultra API, check out the [Ultra API Reference](/docs/api/ultra-api/balances.api.mdx).
12+
:::warning
13+
This Ultra endpoint is not maintained in favour of the [Get Holdings](/docs/ultra-api/get-holdings) endpoint, please use that instead.
2714
:::
2815

29-
## Get Balances
16+
## Get Balances (Deprecated)
3017

3118
The Ultra API supports a simple endpoint to get the token balances of an account, you just need to pass in the required parameter of the user's wallet address.
3219

‎docs/101-ultra-api/3-get-holdings.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
sidebar_label: "Get Holdings"
3+
description: "Request for detailed token holdings of an account including token account information"
4+
title: "Get Holdings"
5+
---
6+
7+
<head>
8+
<title>Get Holdings</title>
9+
<meta name="twitter:card" content="summary" />
10+
</head>
11+
12+
:::note
13+
Lite URL: `https://lite-api.jup.ag/ultra/v1/holdings`
14+
Dynamic URL: `https://api.jup.ag/ultra/v1/holdings`
15+
16+
Dynamic Rate Limits are now applied to Ultra API.
17+
18+
- No Pro plans or payment needed.
19+
- Simply generate the universal API Key via [Portal](https://portal.jup.ag)
20+
- Rate limits scale together with your swap volume.
21+
22+
[Read more about Ultra API Dynamic Rate Limit](/docs/api-rate-limit).
23+
:::
24+
25+
:::tip API Reference
26+
To fully utilize the Ultra API, check out the [Ultra API Reference](/docs/api/ultra-api/holdings.api.mdx).
27+
:::
28+
29+
## Get Holdings
30+
31+
The Ultra API supports a simple endpoint to get the detailed token holdings of an account, you just need to pass in the required parameter of the user's wallet address.
32+
33+
```jsx
34+
const holdingsResponse = await (
35+
await fetch(`https://lite-api.jup.ag/ultra/v1/holdings/3X2LFoTQecbpqCR7G5tL1kczqBKurjKPHhKSZrJ4wgWc`)
36+
).json();
37+
38+
console.log(JSON.stringify(holdingsResponse, null, 2));
39+
```
40+
41+
## Holdings Response
42+
43+
The holdings response will return the following:
44+
- A list of token holdings for the user's wallet address.
45+
- Token account information for each token holding.
46+
- Note that the top level response outside of `tokens` is the native SOL balance.
47+
48+
:::tip
49+
For tokens with more than thousands of token holdings, the response may be slow - depending on the number of token holdings, the response time may vary.
50+
51+
If you only need the native SOL balance, you can use `/holdings/{address}/native` to get the native SOL balance.
52+
:::
53+
54+
**Successful example response:**
55+
56+
```json
57+
{
58+
"amount": "1000000000",
59+
"uiAmount": 1,
60+
"uiAmountString": "1",
61+
"tokens": {
62+
"jupSoLaHXQiZZTSfEWMTRRgpnyFm8f6sZdosWBjx93v": [
63+
{
64+
"account": "tokenaccountaddress",
65+
"amount": "1000000000",
66+
"uiAmount": 1,
67+
"uiAmountString": "1",
68+
"isFrozen": false,
69+
"isAssociatedTokenAccount": true,
70+
"decimals": 9,
71+
"programId": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
72+
}
73+
]
74+
}
75+
}
76+
```
77+
78+
**Failed example response:**
79+
80+
```json
81+
{
82+
"error": "Invalid address"
83+
}
84+
```

‎docs/102-trigger-api/1-create-order.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Do note that there are a few optional parameters that you can use, such as:
4646

4747
```jsx
4848
const createOrderResponse = await (
49-
await fetch('https://api.jup.ag/trigger/v1/createOrder', {
49+
await fetch('https://lite-api.jup.ag/trigger/v1/createOrder', {
5050
method: 'POST',
5151
headers: {
5252
'Content-Type': 'application/json',

‎docs/3-api-setup.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Depending on your needs, you can choose from the following plans:
5555
## Payment
5656

5757
:::note
58-
We are working on adding more payment methods.
58+
Refer to [Payment Method](/docs/api-payment-method) for more details.
5959
:::
6060

6161
:::info Plan Renewal

‎docs/7-api-payment-method.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
sidebar_label: "Payment Method"
3+
description: "Payment Method in Jupiter Portal"
4+
title: "Payment Method"
5+
---
6+
7+
<head>
8+
<title>Payment Method</title>
9+
<meta name="twitter:card" content="summary" />
10+
</head>
11+
12+
This section covers the payment method in Jupiter Portal.
13+
14+
15+
## Overview
16+
17+
The payment methods provided on Portal only applies to the **PRO PLAN**.
18+
19+
- **Lite Plan**: Free tier, no payment required.
20+
- **Pro Plan**: Tiered pricing.
21+
- **Ultra Plan**: No payment via Portal needed.
22+
23+
:::note
24+
For Lite and Ultra plans, you can use the API directly without any payment on Portal.
25+
26+
(Note that Ultra plan will require a free API Key to be generated first. You can find more details in [API Setup](/docs/api-setup) and [API Rate Limit](/docs/api-rate-limit) docs.)
27+
:::
28+
29+
## Payment Method
30+
31+
We currently support 2 payment methods:
32+
- Crypto - USDC on Solana via Helio
33+
- Credit card - USD via CoinFlow
34+
35+
To pay for higher rate limits on Pro plan, you can choose either of the payment methods via the Portal UI.
36+
37+
### Crypto
38+
39+
| Property | Details |
40+
|----------|---------|
41+
| **Payment** | The payment is done in Solana USDC only. |
42+
| **Cadence** | The payment is currently done on a monthly basis, which means you will need to revisit Portal and manually renew each month. |
43+
| **Expiry** | 7 days before the plan expires, you will see the state change in the dashboard's table and receive an automated email as a reminder to renew. Upon expiry, your key will remain valid for a grace period but will be disabled (but not deleted) when it ends. |
44+
| **Renewal** | If you choose to "Renew", the plan will be renewed to the same plan as the previous month. To change plan, you can upgrade/downgrade your plan at any time and cost will be pro-rated. |
45+
| **Fee** | Jupiter incurs the payment service fees. |
46+
| **Changing of payment method** | From Crypto to Credit Card:<br/>1. Wait for plan to expire<br/>2. Pay using the credit card payment method. |
47+
48+
### Credit Card
49+
50+
| Property | Details |
51+
|----------|---------|
52+
| **Payment** | The payment is done in USD only. |
53+
| **Cadence** | The subscription is automatically renewed and funds deducted on a monthly basis. |
54+
| **Fee** | User incurs the credit card payment service fees at 3.4% of the payment amount + $0.25. |
55+
| **Changing of cards** | For security, changing of cards require a few extra steps and cannot be done in the middle of the subscription.<br/>1. Cancel current plan<br/>2. Wait for plan to expire<br/>3. Resubscribe a plan with the new card. |
56+
| **Upgrading of plans** | You can upgrade your plan at any time.<br/>- The cost of the new plan will be charged immediately, while the pro-rated unused cost of the previous plan will be refunded.<br/>- The subscription date will be updated to the date of the upgrade.<br/>- Do note that the refund will be processed at least 1-2 business days after the upgrade. |
57+
| **Downgrading of plans** | You can downgrade by cancelling your plan and subscribing to a lower plan after expiry. |
58+
| **Cancellation of plans** | No refund will be given for unused days and the Pro plan will continue until the expected expiry date. |
59+
| **Changing of payment method** | From Credit Card to Crypto:<br/>1. Cancel current plan so it does not automatically renew<br/>2. Wait for plan to expire<br/>3. Pay using the crypto payment method. |
60+
| **Other Caveats** | - Registered card address must be the billing address.<br/>- No usage of disposable cards as payments are made for a recurring subscription plan. |

0 commit comments

Comments
 (0)