getRecurringOrders

GET 
https://lite-api.jup.ag/recurring/v1/getRecurringOrders

Request for the active or historical orders associated to the provided account

note

• recurringType is used to denote the type of recurring order, can be time or price
• Do note that each recurring type's data format is different, make sure you handle both accordingly
• Refer to Recurring API doc for more information

Request

Path Parameters

recurringType RecurringOrderTyperequired

Possible values: [time, price, all]

orderStatus OrderStaterequired

Possible values: [active, history]

user stringrequired
page int64required

Possible values: >= 0

mint stringnull
includeFailedTx booleanrequired

Responses

200

Successfully retrieved recurring orders

application/json

Schema

Schema

oneOf
MOD1
orderStatusOrderState (string)required
Possible values: [active, history]
pageint64required
Possible values: >= 0
time object[]required
Array [
closeTxstringrequired
createdAtdate-timerequired
cycleFrequencystringrequired
inAmountPerCyclestringrequired
inDepositedstringrequired
inUsedstringrequired
inWithdrawnstringrequired
inputMintstringrequired
maxOutAmountstringrequired
minOutAmountstringrequired
openTxstringrequired
orderKeystringrequired
outReceivedstringrequired
outWithdrawnstringrequired
outputMintstringrequired
rawInAmountPerCyclestringrequired
rawInDepositedstringrequired
rawInUsedstringrequired
rawInWithdrawnstringrequired
rawMaxOutAmountstringrequired
rawMinOutAmountstringrequired
rawOutReceivedstringrequired
rawOutWithdrawnstringrequired
trades object[]required
Array [
actionstringrequired
confirmedAtdate-timerequired
feeAmountstringrequired
feeMintstringrequired
inputAmountstringrequired
inputMintstringrequired
keeperstringrequired
orderKeystringrequired
outputAmountstringrequired
outputMintstringrequired
productMeta
Extra metadata for sub-products which will never be queried
with filters.
See structs DbOrderHistoryValueAverageMeta and DbOrderHistoryPerpetualMeta
to craft the JSONB object.
rawFeeAmountstringrequired
rawInputAmountstringrequired
rawOutputAmountstringrequired
txIdstringrequired
]
updatedAtdate-timerequired
userClosedbooleanrequired
userPubkeystringrequired
]
totalPagesint64required
Possible values: >= 0
userstringrequired
MOD2
orderStatusOrderState (string)required
Possible values: [active, history]
pageint64required
Possible values: >= 0
price object[]required
Array [
closeTxstringrequired
closedBystringrequired
createdAtdate-timerequired
estimatedUsdcValueSpentstringrequired
inDepositedstringrequired
inLeftstringrequired
inUsedstringrequired
Amount used to fulfill orders
inWithdrawnstringrequired
incrementalUsdValuestringrequired
inputMintstringrequired
openTxstringrequired
orderIntervalstringrequired
orderKeystringrequired
outReceivedstringrequired
Amount received in escrow without auto-withdraw enabled
outWithdrawnstringrequired
Amount withdrawn from escrow account with/without auto-withdraw enabled
outputMintstringrequired
rawEstimatedUsdcValueSpentstringrequired
rawInDepositedstringrequired
rawInLeftstringrequired
rawInUsedstringrequired
Amount used to fulfill orders
rawInWithdrawnstringrequired
rawIncrementalUsdValuestringrequired
rawOutReceivedstringrequired
Amount received in escrow without auto-withdraw enabled
rawOutWithdrawnstringrequired
Amount withdrawn from escrow account with/without auto-withdraw enabled
rawSupposedUsdValuestringrequired
startAtdate-timerequired
statusstringrequired
supposedUsdValuestringrequired
trades object[]required
Array [
actionstringrequired
confirmedAtdate-timerequired
feeAmountstringrequired
feeMintstringrequired
inputAmountstringrequired
inputMintstringrequired
keeperstringrequired
orderKeystringrequired
outputAmountstringrequired
outputMintstringrequired
productMeta
Extra metadata for sub-products which will never be queried
with filters.
See structs DbOrderHistoryValueAverageMeta and DbOrderHistoryPerpetualMeta
to craft the JSONB object.
rawFeeAmountstringrequired
rawInputAmountstringrequired
rawOutputAmountstringrequired
txIdstringrequired
]
updatedAtdate-timerequired
userPubkeystringrequired
]
totalPagesint64required
Possible values: >= 0
userstringrequired
MOD3
all object[]required
Array [
oneOf
MOD1
closeTxstringrequired
createdAtdate-timerequired
cycleFrequencystringrequired
inAmountPerCyclestringrequired
inDepositedstringrequired
inUsedstringrequired
inWithdrawnstringrequired
inputMintstringrequired
maxOutAmountstringrequired
minOutAmountstringrequired
openTxstringrequired
orderKeystringrequired
outReceivedstringrequired
outWithdrawnstringrequired
outputMintstringrequired
rawInAmountPerCyclestringrequired
rawInDepositedstringrequired
rawInUsedstringrequired
rawInWithdrawnstringrequired
rawMaxOutAmountstringrequired
rawMinOutAmountstringrequired
rawOutReceivedstringrequired
rawOutWithdrawnstringrequired
trades object[]required
Array [
actionstringrequired
confirmedAtdate-timerequired
feeAmountstringrequired
feeMintstringrequired
inputAmountstringrequired
inputMintstringrequired
keeperstringrequired
orderKeystringrequired
outputAmountstringrequired
outputMintstringrequired
productMeta
Extra metadata for sub-products which will never be queried
with filters.
See structs DbOrderHistoryValueAverageMeta and DbOrderHistoryPerpetualMeta
to craft the JSONB object.
rawFeeAmountstringrequired
rawInputAmountstringrequired
rawOutputAmountstringrequired
txIdstringrequired
]
updatedAtdate-timerequired
userClosedbooleanrequired
userPubkeystringrequired
recurringTypestringrequired
Possible values: [time]
MOD2
closeTxstringrequired
closedBystringrequired
createdAtdate-timerequired
estimatedUsdcValueSpentstringrequired
inDepositedstringrequired
inLeftstringrequired
inUsedstringrequired
Amount used to fulfill orders
inWithdrawnstringrequired
incrementalUsdValuestringrequired
inputMintstringrequired
openTxstringrequired
orderIntervalstringrequired
orderKeystringrequired
outReceivedstringrequired
Amount received in escrow without auto-withdraw enabled
outWithdrawnstringrequired
Amount withdrawn from escrow account with/without auto-withdraw enabled
outputMintstringrequired
rawEstimatedUsdcValueSpentstringrequired
rawInDepositedstringrequired
rawInLeftstringrequired
rawInUsedstringrequired
Amount used to fulfill orders
rawInWithdrawnstringrequired
rawIncrementalUsdValuestringrequired
rawOutReceivedstringrequired
Amount received in escrow without auto-withdraw enabled
rawOutWithdrawnstringrequired
Amount withdrawn from escrow account with/without auto-withdraw enabled
rawSupposedUsdValuestringrequired
startAtdate-timerequired
statusstringrequired
supposedUsdValuestringrequired
trades object[]required
Array [
actionstringrequired
confirmedAtdate-timerequired
feeAmountstringrequired
feeMintstringrequired
inputAmountstringrequired
inputMintstringrequired
keeperstringrequired
orderKeystringrequired
outputAmountstringrequired
outputMintstringrequired
productMeta
Extra metadata for sub-products which will never be queried
with filters.
See structs DbOrderHistoryValueAverageMeta and DbOrderHistoryPerpetualMeta
to craft the JSONB object.
rawFeeAmountstringrequired
rawInputAmountstringrequired
rawOutputAmountstringrequired
txIdstringrequired
]
updatedAtdate-timerequired
userPubkeystringrequired
recurringTypestringrequired
Possible values: [price]
]
orderStatusOrderState (string)required
Possible values: [active, history]
pageint64required
Possible values: >= 0
totalPagesint64required
Possible values: >= 0
userstringrequired

Example (auto)

{
  "orderStatus": "active",
  "page": 0,
  "time": [
    {
      "closeTx": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "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": "2024-07-29T15:51:28.071Z",
          "feeAmount": "string",
          "feeMint": "string",
          "inputAmount": "string",
          "inputMint": "string",
          "keeper": "string",
          "orderKey": "string",
          "outputAmount": "string",
          "outputMint": "string",
          "rawFeeAmount": "string",
          "rawInputAmount": "string",
          "rawOutputAmount": "string",
          "txId": "string"
        }
      ],
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "userClosed": true,
      "userPubkey": "string"
    }
  ],
  "totalPages": 0,
  "user": "string"
}

400

Bad request

500

Internal server error

• curl
• nodejs
• python
• rust

• CURL

curl -L 'https://lite-api.jup.ag/recurring/v1/getRecurringOrders' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://lite-api.jup.ag/recurring/v1

Parameters

recurringType — pathrequired

---timepriceall

orderStatus — pathrequired

---activehistory

user — pathrequired

page — pathrequired

includeFailedTx — pathrequired

---truefalse

mint — path

ResponseClear

Click the Send API Request button above and see the response here!