Orders

Orders across every service.

GET/api/v1/ordersscope: api.<service>.read

List orders

Orders placed through the API or the dashboard, newest first, for the services this key may read. A summary: payment and paid_at are on GET /api/v1/orders/{id}.

Requires the read level on at least one service.

Query

limit

integer

How many results to return, 1–100. Default: 50.

offset

integer

How many results to skip. Default: 0.

service

string

Only this service's orders, e.g. static or residential.

status

string

Only orders in this state.

pendingrequires_actionpaidcompleteddelivery_failedfailedexpiredrefunded

Request

cURL

curl https://api.datafuel.ai/api/v1/orders \
  --header 'Authorization: Bearer df_live_your_key_here'

Response

{
  "results": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "pending",
      "service": "string",
      "product": "string",
      "action": "new",
      "total": 0,
      "currency": "usd",
      "plan_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action_url": "https://example.com",
      "error": {
        "code": "insufficient_balance",
        "message": "string"
      },
      "created_at": "2026-01-01T00:00:00Z"
    }
  ],
  "count": 0,
  "limit": 0,
  "offset": 0
}

{
  "error": "string",
  "message": "string",
  "meta": {}
}

{
  "error": "string",
  "message": "string",
  "meta": {}
}

{
  "error": "string",
  "message": "string",
  "meta": {}
}

{
  "error": "string",
  "message": "string",
  "meta": {}
}

{
  "error": "string",
  "message": "string",
  "meta": {}
}

GET/api/v1/orders/{order}scope: api.<service>.read

Get an order

Poll this after a 202 until the status is completed, delivery_failed, failed, expired or refunded, and stop after a few minutes: a delivery normally takes seconds. plan_id is the delivered plan's id, usable with that service's /plans/{plan}.

Requires the read level on at least one service.

Path

orderREQUIRED

string

The order's id.

Request

cURL

curl https://api.datafuel.ai/api/v1/orders/{order} \
  --header 'Authorization: Bearer df_live_your_key_here'

Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "pending",
  "service": "string",
  "product": "string",
  "action": "new",
  "total": 0,
  "currency": "usd",
  "payment": {
    "method": "balance",
    "card_id": "string"
  },
  "plan_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "action_url": "https://example.com",
  "error": {
    "code": "insufficient_balance",
    "message": "string"
  },
  "replayed": false,
  "created_at": "2026-01-01T00:00:00Z",
  "paid_at": "2026-01-01T00:00:00Z"
}

{
  "error": "string",
  "message": "string",
  "meta": {}
}

{
  "error": "string",
  "message": "string",
  "meta": {}
}

{
  "error": "string",
  "message": "string",
  "meta": {}
}

{
  "error": "string",
  "message": "string",
  "meta": {}
}

{
  "error": "string",
  "message": "string",
  "meta": {}
}