Skip to main content
GET
/
order
/
list
curl --request GET \
  --url 'https://api.starkfi.io/order/list?page=1&limit=20' \
  --header 'x-api-key: <api_key>'

{
  "statusCode": 200,
  "success": true,
  "status": "orders_listed",
  "message": "Orders listed successfully.",
  "data": {
    "orders": [],
    "pagination": {
      "total": 0,
      "page": 1,
      "limit": 20,
      "total_pages": 0
    }
  }
}
​
x-api-key
string
required
Your StarkFi API key. You can find it in your dashboard.
​
page
number
Page number (default 1, must be ≥ 1).
​
limit
number
Page size (default 20, maximum 100).
​
gateway_method
enum<string>
Filter by direct or subs.
​
on_ramp
boolean
Filter by on-ramp flag (true / false).
curl --request GET \
  --url 'https://api.starkfi.io/order/list?page=1&limit=20' \
  --header 'x-api-key: <api_key>'

{
  "statusCode": 200,
  "success": true,
  "status": "orders_listed",
  "message": "Orders listed successfully.",
  "data": {
    "orders": [],
    "pagination": {
      "total": 0,
      "page": 1,
      "limit": 20,
      "total_pages": 0
    }
  }
}

​
Response

​
data.orders
array
required
Array of full payment_orders rows for the tenant.
​
data.pagination
object
required