Run a limit order bot with Javascript
Jupiter Limit Order provides users with the simplest way to place limit orders on Solana and receive tokens directly in your wallet when the order is filled!
Create Limit Order
1. Install the libraries
To run this example requires a minimum of NodeJS 16. In your command line terminal, install the libraries.
npm i @solana/web3.js
npm i cross-fetch
npm i @project-serum/anchor
npm i bs58
2. Import from libraries and setup connection
Next you can copy the following code snippets to a javascript file jupiter-api-example.js. And when you are ready to run the code, just type: node jupiter-api-example.js
import { Connection, Keypair, VersionedTransaction } from '@solana/web3.js';
import fetch from 'cross-fetch';
import { Wallet } from '@project-serum/anchor';
import bs58 from 'bs58';
// It is recommended that you use your own RPC endpoint.
// This RPC endpoint is only for demonstration purposes so that this example will run.
const connection = new Connection('https://neat-hidden-sanctuary.solana-mainnet.discover.quiknode.pro/2af5315d336f9ae920028bbb90a73b724dc1bbed/');
Always make sure that you are using your own RPC endpoint. The RPC endpoint used by the connection object in the above example may not work anymore.
3. Setup your wallet
In this example, you can paste in your private key for testing purposes but this is not recommended for production applications.
const wallet = new Wallet(Keypair.fromSecretKey(bs58.decode(process.env.PRIVATE_KEY || '')));
const referral = new Wallet(Keypair.fromSecretKey(bs58.decode(process.env.REFERRAL_PRIVATE_KEY || '')));
4. Get the serialized transactions to perform the swap
// Base key are used to generate a unique order id
const base = Keypair.generate();
// get serialized transactions
const transactions = await (
await fetch('https://jup.ag/api/limit/v1/createOrder', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
owner: wallet.publicKey.toString(),
inAmount: 100000, // 1000000 => 1 USDC if inputToken.address is USDC mint
outAmount: 100000,
inputMint: inputMint.toString(),
outputMint: outputMint.toString(),
expiredAt: null // new Date().valueOf() / 1000,
base: base.publicKey.toString(),
referral: referral.publicKey.toString() //optional, more details in the section below
})
})
).json();
const { tx } = transactions;
expiredAt - It can be either null or Unix timestamp in seconds.
5. Deserialize and sign the transaction
// deserialize the transaction
const transactionBuf = Buffer.from(tx, 'base64');
var transaction = VersionedTransaction.deserialize(transactionBuf);
console.log(transaction);
// sign the transaction
transaction.sign([wallet.payer, base]);
After you deserialize the transaction you can insert your own instructions in the transaction to support your use case.
6. Execute the transaction
// Execute the transaction
const rawTransaction = transaction.serialize()
const txid = await connection.sendRawTransaction(rawTransaction, {
skipPreflight: true,
maxRetries: 2
});
await connection.confirmTransaction(txid);
console.log(`https://solscan.io/tx/${txid}`);
Query user open order, order history and trade history
GEThttps://jup.ag/api/limit/v1/openOrders
https://jup.ag/api/limit/v1/openOrders
Parameters
| Query | Type | Required |
|---|---|---|
wallet | string | Yes |
Response
• 200: OKSuccess Response
[
{
"publicKey": "string",
"account": {
"maker": "string",
"inputMint": "string",
"outputMint": "string",
"oriInAmount": 0,
"oriOutAmount": 0,
"inAmount": 0,
"outAmount": 0,
"expiredAt": 0,
"base": "string"
}
}
]
• default Error Response
{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}
GEThttps://jup.ag/api/limit/v1/orderHistory
https://jup.ag/api/limit/v1/orderHistory
Parameters
| Query | Type | Required |
|---|---|---|
wallet | string | Yes |
cursor | number | No |
skip | number | No |
take | number | No |
Response
• 200: OKSuccess Response
[
{
"id": 0,
"orderKey": "string",
"maker": "string",
"inputMint": "string",
"outputMint": "string",
"inAmount": 0,
"oriInAmount": 0,
"outAmount": 0,
"oriOutAmount": 0,
"expiredAt": 0,
"state": "Waiting",
"createTxid": "string",
"cancelTxid": "string",
"updatedAt": "2023-05-05T07:48:36.390Z",
"createdAt": "2023-05-05T07:48:36.390Z"
}
]
• default Error Response
{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}
GEThttps://jup.ag/api/limit/v1/tradeHistory
https://jup.ag/api/limit/v1/tradeHistory
Parameters
| Query | Type | Required |
|---|---|---|
wallet | string | Yes |
cursor | number | No |
skip | number | No |
take | number | No |
Response
• 200: OKSuccess Response
[
{
"id": 0,
"outAmount": 0,
"txid": "string",
"updatedAt": "2023-05-05T07:48:36.390Z",
"createdAt": "2023-05-05T07:48:36.390Z",
"order": {
"id": 0,
"orderKey": "string",
"inputMint": "string",
"outputMint": "string"
}
}
]
• default Error Response
{
"message": "string",
"code": "string",
"issues": [
{
"message": "string"
}
]
}
Cancel order
POSThttps://jup.ag/api/limit/v1/cancelOrders
https://jup.ag/api/limit/v1/cancelOrders
Deserialize, sign and execute the transaction from the response like here.
Due to the transaction size limit, the maximum cancellation order in a batch is 10.
Referral
Referrers are entitled to a share of 0.1% of referral fees, while the platform collects another 0.1%. The fees are collected and withheld by the program and are claimable anytime.
1. Create a referral account
POSThttps://jup.ag/api/limit/v1/createReferralAccount
https://jup.ag/api/limit/v1/createReferralAccount
Deserialize, sign and execute the transaction from the response like here.
2. Create referral token accounts
For every token you would like to collect referral fees in, you need to generate a token account for that. Referral fees are given in the output mint token.
POSThttps://jup.ag/api/limit/v1/createReferralTokenAccount
https://jup.ag/api/limit/v1/createReferralTokenAccount
Deserialize, sign and execute the transaction from the response like here.
3. Collect fees
Once you include your referralPubKey in LimitOrderProvider initialization and output mint referral token account have been created, the referral fees will be credited into the token account after the order has been fulfilled.
4. Claim fees
POSThttps://jup.ag/api/limit/v1/claimReferral
https://jup.ag/api/limit/v1/claimReferral
Deserialize, sign and execute the transaction from the response like here.