Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spherepay.co/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a paginated list of all quotes created by your application. Useful for auditing past rate locks, building a history view in your UI, or finding the most recent active quote for a customer.

​
Endpoint

GET https://api.spherepay.co/v2/quote

​
Authentication

All requests require a Bearer token in the Authorization header. 
Authorization: Bearer <token>

​
Query parameters

​
page
string
default:"1"
required
Page number of the list. Default "1".
​
limit
string
default:"10"
required
Number of items per page. Default "10". Maximum "100".
​
customerId
string
Filter quotes by customer ID. Matches ^customer_[a-z0-9]+$.
​
status
string
Filter quotes by status. One of active, used, or expired.

​
Response fields

​
page
number
Current page number.
​
limit
number
Items per page in this response.
​
total
number
Total number of quotes matching the filter.
​
data
object[]
Array of quote objects. Each entry has the same shape as the response from Create Quote: id, status, type, customerId, fees, source, destination, expiresAt, created, and updated.
curl "https://api.spherepay.co/v2/quote?page=1&limit=10" \
  -H "Authorization: Bearer $SPHEREPAY_API_KEY"

{
  "page": 1,
  "limit": 10,
  "total": 1,
  "data": [
    {
      "id": "quote_d243ab2b1de4447d8a046d87fefe58cf",
      "status": "active",
      "type": "off_ramp",
      "customerId": "customer_3faa484998f44cfead9668608b9ee1f5",
      "fees": {
        "integratorFee": {
          "fixedAmount": "0.00",
          "bpsRate": "20",
          "bpsAmount": "0.20",
          "totalAmount": "0.20",
          "currency": "usdc"
        },
        "platformFee": {
          "fixedAmount": "0.00",
          "bpsRate": "20",
          "bpsAmount": "0.20",
          "totalAmount": "0.20",
          "currency": "usdc"
        }
      },
      "source": {
        "currency": "usdc",
        "network": "polygon",
        "amount": "100.00"
      },
      "destination": {
        "currency": "brl",
        "network": "pix",
        "amount": "545.50",
        "exchangeRate": "5.455"
      },
      "expiresAt": "2025-01-01T00:01:00.000Z",
      "created": "2025-01-01T00:00:00.000Z",
      "updated": "2025-01-01T00:00:00.000Z"
    }
  ]
}

​
Error codes

StatusCodeDescription
400address/invalidA query parameter is malformed.
422validation/failedOne or more query parameters failed validation.
Last modified on May 21, 2026