Skip to main content
GET
/
getRecurringOrders
getRecurringOrders
curl --request GET \
  --url https://api.jup.ag/recurring/v1/getRecurringOrders \
  --header 'x-api-key: <api-key>'
{
  "orderStatus": "active",
  "page": 2,
  "time": [
    {
      "closeTx": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "cycleFrequency": "<string>",
      "inAmountPerCycle": "<string>",
      "inDeposited": "<string>",
      "inUsed": "<string>",
      "inWithdrawn": "<string>",
      "inputMint": "<string>",
      "maxOutAmount": "<string>",
      "minOutAmount": "<string>",
      "openTx": "<string>",
      "orderKey": "<string>",
      "outReceived": "<string>",
      "outWithdrawn": "<string>",
      "outputMint": "<string>",
      "rawInAmountPerCycle": "<string>",
      "rawInDeposited": "<string>",
      "rawInUsed": "<string>",
      "rawInWithdrawn": "<string>",
      "rawMaxOutAmount": "<string>",
      "rawMinOutAmount": "<string>",
      "rawOutReceived": "<string>",
      "rawOutWithdrawn": "<string>",
      "trades": [
        {
          "action": "<string>",
          "confirmedAt": "2023-11-07T05:31:56Z",
          "feeAmount": "<string>",
          "feeMint": "<string>",
          "inputAmount": "<string>",
          "inputMint": "<string>",
          "keeper": "<string>",
          "orderKey": "<string>",
          "outputAmount": "<string>",
          "outputMint": "<string>",
          "rawFeeAmount": "<string>",
          "rawInputAmount": "<string>",
          "rawOutputAmount": "<string>",
          "txId": "<string>",
          "productMeta": "<unknown>"
        }
      ],
      "updatedAt": "2023-11-07T05:31:56Z",
      "userClosed": true,
      "userPubkey": "<string>"
    }
  ],
  "totalPages": 2,
  "user": "<string>"
}
NOTE
  • recurringType is used to denote the type of recurring order, only time
  • DEPRECATED: recurringType: price based orders are deprecated

Authorizations

​
x-api-key
string
header
required

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

Query Parameters

​
recurringType
enum<string>
required

Type of recurring order. DEPRECATED: The 'price' value is deprecated.

Available options:
time,
price,
all
​
orderStatus
enum<string>
required
Available options:
active,
history
​
user
string
required
​
page
integer<int64> | null
required
Required range: x >= 1
​
mint
string | null
required
​
includeFailedTx
boolean
required

Response

Successfully retrieved recurring orders

​
orderStatus
enum<string>
required
Available options:
active,
history
​
page
integer<int64>
required
Required range: x >= 1
​
time
object[]
required
​
totalPages
integer<int64>
required
Required range: x >= 1
​
user
string
required