Skip to main content

Search Trades

This endpoint allows you to search and list trades with pagination support.

Endpoint

GET /api/v1/trades

Headers

NameTypeDescription
AuthorizationstringBearer token for authentication
X-Target-ServerstringTarget server identifier (e.g., "declaration")

Query Parameters

NameTypeDescription
pageintegerPage number for pagination (default: 1)
per_pageintegerNumber of items per page (default: 10)

Response

Success Response (200 OK)

{
"data": [
{
"id": "string",
"name": "string",
"node_name": "string",
"node_id": "string",
"status": "integer",
"type": "integer",
"permissions": [
{
"node_id": "string",
"created_at": "string"
}
],
"created_by": "string",
"created_at": "string",
"updated_at": "string"
}
],
"total": "integer",
"page": "integer",
"per_page": "integer"
}

Response Fields

FieldTypeDescription
dataarrayArray of trade objects
data[].idstringUnique identifier of the trade
data[].namestringName of the trade
data[].node_namestringName of the node
data[].node_idstringID of the node
data[].statusintegerStatus of the trade
data[].typeintegerType of the trade
data[].permissionsarrayArray of permission objects
data[].permissions[].node_idstringID of the node with permission
data[].permissions[].created_atstringCreation timestamp of the permission
data[].created_bystringID of the user who created the trade
data[].created_atstringCreation timestamp of the trade
data[].updated_atstringLast update timestamp of the trade
totalintegerTotal number of trades
pageintegerCurrent page number
per_pageintegerNumber of items per page

Example Request

curl --request GET \
--url '{{HOST}}/api/v1/trades?page=1&per_page=10' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--header 'X-Target-Server: declaration'

Example Response

{
"data": [
{
"id": "68247532b5e19b4fafa3f894",
"name": "API Trade",
"node_name": "Interzoon A.S",
"node_id": "6784fea5481a2963fcb2d74c",
"status": 1,
"type": 1,
"permissions": [],
"created_by": "6784fea5481a2963fcb2d74d",
"created_at": "2025-05-14T10:49:22.835Z",
"updated_at": "2025-05-14T10:49:22.835Z"
}
],
"total": 19,
"page": 1,
"per_page": 10
}