List withdrawalsGET

OpenStock Docs

GET

/api/withdrawal-api/withdrawals

withdrawal_api

Returns withdrawals requested through the API, newest first.

Authorization#

AuthorizationBearer <token>

In: header. A store API key starting with sk_ that has the withdrawal_api permission.

Query parameters#

limitinteger

Number of results to return, between 1 and 100. Default: 20

offsetinteger

Number of results to skip. Default: 0

statusstring

Filter by status: pending, completed or failed.

Responses#

200A page of withdrawals.
401Missing, malformed, disabled or expired API key.

curl -X GET "https://openstock.dev/api/withdrawal-api/withdrawals" \
  -H "Authorization: Bearer $OPENSTOCK_API_KEY"

A page of withdrawals.

{
  "data": [
    {
      "id": "wd_4b8e2f0c9a1d",
      "status": "completed",
      "amount": 0.05,
      "fee_amount": 0.002,
      "net_amount": 0.048,
      "currency": "LTC",
      "to_address": "ltc1qexampleaddressxxxxxxxxxxxxxxxxxxxxxx",
      "tx_hash": "3f6c…e91a",
      "created_at": "2026-03-04T18:30:00.000Z",
      "completed_at": "2026-03-04T18:31:12.000Z"
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}