On this page Overview

List orders

Read your order history, newest first, in pages of up to 20 orders.

01 / Request

Make a request

GET/api/v1/orders

Start with offset=0 and increase by 20 while hasMore is true. Stop when hasMore is false.

This is offset pagination ordered by created_at and id, newest first. New purchases can shift later pages; deduplicate by order id when collecting history.

Required headers

AuthorizationstringRequired: Bearer followed by your ScrapingBuddy customer API key. Keep it on your server.

Authentication guide

Query parameters

offsetintegerOptional: Defaults to 0. Use 0, 20, 40 and so on. Allowed range: 0 to 100000.

GET /orders

# Set SCRAPINGBUDDY_API_KEY in your server environment.
curl "https://www.scrapingbuddy.com/api/v1/orders?offset=0" \
  -H "Authorization: Bearer $SCRAPINGBUDDY_API_KEY"

Node.js 20+

// Node.js 20+. Keep credentials on your server.
const base = "https://www.scrapingbuddy.com/api/v1";
const response = await fetch(base + "/orders?offset=0", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.SCRAPINGBUDDY_API_KEY,
  },
  signal: AbortSignal.timeout(30000),
});
const data = await response.json();
if (!response.ok) throw new Error(response.status + ": " + data.error);
console.log(data);

Python 3 + requests

# Python 3. Install: pip install requests
import os
import requests

base = "https://www.scrapingbuddy.com/api/v1"
headers = {"Authorization": "Bearer " + os.environ["SCRAPINGBUDDY_API_KEY"]}
response = requests.get(
    base + "/orders?offset=0",
    headers=headers,
    timeout=30,
)
response.raise_for_status()
data = response.json()
print(data)

Base URL https://www.scrapingbuddy.com/api/v1

Set the environment variables shown in the example. Python requires requests; JavaScript requires Node.js 20+. These examples call the live API, not a sandbox.

02 / Response

Understand the response

Success returns HTTP 200 with JSON. Read the fields below before using the result.

ordersarray: Up to 20 order objects. Their fields match the order object in Get an order.
hasMoreboolean: True when another history page is available.

Complete order schema

Example response / illustrative values

{
  "orders": [
    {
      "id": "22222222-2222-4222-8222-222222222222",
      "country": "england",
      "product": "google",
      "operator": "assigned-operator",
      "amount_cents": 25,
      "status": "RECEIVED",
      "phone": "+440000000000",
      "sms": [
        {
          "sender": "Example",
          "text": "Your verification code is 123456",
          "code": "123456",
          "date": "2026-09-12T12:01:00.000Z"
        }
      ],
      "expires_at": "2026-09-12T12:15:00.000Z",
      "created_at": "2026-09-12T12:00:00.000Z",
      "updated_at": "2026-09-12T12:01:00.000Z",
      "refunded_at": null,
      "error_code": null
    }
  ],
  "hasMore": false
}

Prices, stock, phone numbers, messages and timestamps here are illustrative, not live availability or a price guarantee.

Errors & next steps

Failures return an HTTP error status and a JSON error message. Correct validation and authentication errors before retrying. For 429, honor Retry-After; longer account limits may still apply.

All keys share the account limit of 60 API requests per minute. Purchase recovery must keep the original idempotency key and quote ID.

Errors & limits Safe purchases & retries Order lifecycle