Create Order

Request for a base64-encoded unsigned recurring order creation transaction to be used in POST /recurring/v1/execute

POST /createOrder

createOrder

cURL

curl --request POST \
  --url https://api.jup.ag/recurring/v1/createOrder \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user": "jdocuPgEAjMfihABsPgKEvYtsmMzjUHeq9LX4Hvs7f3",
  "inputMint": "So11111111111111111111111111111111111111112",
  "outputMint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
  "params": {
    "time": {
      "inAmount": 1000000000,
      "numberOfOrders": 10,
      "interval": 86400
    }
  }
}
'

import requests

url = "https://api.jup.ag/recurring/v1/createOrder"

payload = {
    "user": "jdocuPgEAjMfihABsPgKEvYtsmMzjUHeq9LX4Hvs7f3",
    "inputMint": "So11111111111111111111111111111111111111112",
    "outputMint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "params": { "time": {
            "inAmount": 1000000000,
            "numberOfOrders": 10,
            "interval": 86400
        } }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    user: 'jdocuPgEAjMfihABsPgKEvYtsmMzjUHeq9LX4Hvs7f3',
    inputMint: 'So11111111111111111111111111111111111111112',
    outputMint: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
    params: {time: {inAmount: 1000000000, numberOfOrders: 10, interval: 86400}}
  })
};

fetch('https://api.jup.ag/recurring/v1/createOrder', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jup.ag/recurring/v1/createOrder",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'user' => 'jdocuPgEAjMfihABsPgKEvYtsmMzjUHeq9LX4Hvs7f3',
    'inputMint' => 'So11111111111111111111111111111111111111112',
    'outputMint' => 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
    'params' => [
        'time' => [
                'inAmount' => 1000000000,
                'numberOfOrders' => 10,
                'interval' => 86400
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jup.ag/recurring/v1/createOrder"

	payload := strings.NewReader("{\n  \"user\": \"jdocuPgEAjMfihABsPgKEvYtsmMzjUHeq9LX4Hvs7f3\",\n  \"inputMint\": \"So11111111111111111111111111111111111111112\",\n  \"outputMint\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n  \"params\": {\n    \"time\": {\n      \"inAmount\": 1000000000,\n      \"numberOfOrders\": 10,\n      \"interval\": 86400\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.jup.ag/recurring/v1/createOrder")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user\": \"jdocuPgEAjMfihABsPgKEvYtsmMzjUHeq9LX4Hvs7f3\",\n  \"inputMint\": \"So11111111111111111111111111111111111111112\",\n  \"outputMint\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n  \"params\": {\n    \"time\": {\n      \"inAmount\": 1000000000,\n      \"numberOfOrders\": 10,\n      \"interval\": 86400\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jup.ag/recurring/v1/createOrder")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user\": \"jdocuPgEAjMfihABsPgKEvYtsmMzjUHeq9LX4Hvs7f3\",\n  \"inputMint\": \"So11111111111111111111111111111111111111112\",\n  \"outputMint\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\",\n  \"params\": {\n    \"time\": {\n      \"inAmount\": 1000000000,\n      \"numberOfOrders\": 10,\n      \"interval\": 86400\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "transaction": "AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgAAEN..."
}

NOTE

• Pass in the correct recurring type in the params field, only time
• DEPRECATED: params.price based orders are deprecated
• Refer to Recurring API doc for more information.

Authorizations

x-api-key · string · header · required

Get API key via https://developers.jup.ag/portal

Body

application/json

inputMint · string · required

outputMint · string · required

params · object · required

Option 1

Option 2

Show child attributes

user · string · required

Response

200

application/json

Recurring order created successfully

requestId · string · required

Required to make a request to /execute

transaction · string · required

Unsigned base-64 encoded transaction