API Methods Reference
Authentication, targets, orders, status tracking, and error handling for PandaBoost API v1.
Authentication
Send the API key in the x-api-key header.
curl -H "x-api-key: REPLACE_ME" \
https://web.pandaboost.app/api/v1/balanceBase URL
https://web.pandaboost.app/api/v1Response envelope
{
"success": true,
"data": {}
}{
"success": false,
"error": "Error message"
}Order lifecycle
pending
Accepted and queued for a manually fulfilled service
processing
Dispatched to a worker
completed
Fulfilment completed
refunded
The charged amount was returned to the account balance
A successful order creation can return either processing or pending. These are order statuses inside the JSON response; the corresponding HTTP transport code is 200.
GET /balance
Returns the current account balance.
GET /services
Returns active services, their order types, target requirements, limits, and the authenticated account's rates.
Call this endpoint before rendering a catalog or placing an order. Do not hard-code availability or rates.
POST /targets/resolve
Resolves a token contract into the liquidity pairs supported by an order type. Pair-level services require one of the returned pair addresses when the order is created.
This authenticated lookup does not create an order or deduct the account balance. If the target cannot be resolved for the selected order type, handle the standard error envelope and do not submit an order with an unverified pair.
Example response shape:
A token contract and a liquidity-pair address are different targets. When pairSelection is required, submit a pairAddress returned for the selected order type.
POST /orders
Creates an order and deducts the calculated amount from the account balance.
Request body
serviceName
string
Service name returned by GET /services
orderTypeId
string
Order type ID returned by GET /services
quantity
number
Quantity within the order type's current minimum and maximum
target
object
Optional token-first object with address and, when required, a selected pairAddress
fields
object
Supported v1 fields and options such as speed
Use one source of truth for target addresses:
Legacy request: omit
targetand send the published token or pair field insidefields.Token-first request: send the token and selected pair in
target; usefieldsonly for non-target options such asspeed.Do not duplicate an address in both formats. The API does not define precedence for conflicting target values; treat a mixed or inconsistent request as invalid.
Token-first format
Existing v1 fields format
Existing integrations can continue using their published field-based request shape.
Successful response
Order creation outcomes
HTTP
200withorder.status: processing: dispatched to a worker. PersistpublicIdand poll the order.HTTP
200withorder.status: pending: queued for a manually fulfilled service. PersistpublicIdand poll the order.HTTP
400withoutrefunded: true: request validation, target, or balance error. Correct the request before trying again.HTTP
400withrefunded: true: dispatch failed and the charged amount was returned automatically. Treat that creation attempt as terminal and do not retry it automatically.HTTP
202withunderReview: trueandpaymentRef: automatic dispatch and automatic refund could not be completed. Retain the reference, check order status, and contact support if needed; do not submit a duplicate order.
HTTP 400 validation or balance error:
HTTP 400 failed dispatch with automatic refund:
HTTP 202 accepted for operator review:
POST /orders deducts balance immediately and is not documented as idempotent. On a timeout or ambiguous response, check the order list and account balance before sending another creation request.
GET /orders
Lists account orders with pagination.
page
1
Page number
limit
20
Items per page, maximum 100
status
all
pending, processing, completed, or refunded
GET /orders/:id
Returns detailed status for a single order that belongs to the authenticated account.
HTTP responses
200
Request completed successfully
202
Accepted for operator review; inspect underReview and retain paymentRef
400
Invalid request, insufficient balance, or failed dispatch; inspect refunded
401
Missing or invalid API key
403
API access is not enabled for the account
404
Resource does not exist or does not belong to the account
500
Internal server error
See Service Payload Examples for current request shapes.
Last updated