Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openxswitch.com/llms.txt

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

OpenXSwitch API uses pagination for REST endpoints that return array-based responses. Pagination allows applications to retrieve large datasets in smaller, structured batches. Endpoints that return lists such as deposits, withdrawals, transactions, wallets, orders, or sub-wallets support pagination through the pageNo and pageLimit query parameters. By default, endpoints return the most recent records first.
The base endpoint is: https://api.openxswitch.com

​
Example Request

GET {base}/v1/sub-wallet/list?pageNo=1&pageLimit=20
Example response: 
{
  "pageNo": 1,
  "pageLimit": 20,
  "totalPage": 1,
  "data": []
}

​
Pagination Parameters

ParameterDefaultDescription
pageNo1Specifies the current page number to retrieve.
pageLimit10Specifies the number of records returned per request.

​
Pagination Response Fields

FieldDescription
pageNoCurrent page number returned in the response.
pageLimitNumber of records returned per page.
totalPageTotal number of available pages for the request.
dataArray containing the requested records.

​
Usage Notes

  • Pagination is supported only on endpoints that return array-based results.
  • Results are typically returned in descending order based on creation time or latest activity.
  • To retrieve additional records, increment the pageNo value in subsequent requests.
  • The pageLimit parameter controls the maximum number of records returned per request.