Skip to main content

Get OTC Group Search

Search for OTC (Over-The-Counter) deals associated with a specific user.

Endpoint​

GET /v2/users/{user_id}/otcs

Headers​

HeaderValue
AuthorizationBearer {token}

Path Parameters​

ParameterTypeRequiredDescription
user_idstringYesThe unique identifier of the user

Query Parameters​

This endpoint is a GET: paging and filters travel in the query string, not in a JSON body. There is no request body.

Parameters​

ParameterTypeRequiredDescription
pageintegerYesPage number for pagination
per_pageintegerYesNumber of items per page

Response​

Returns a paginated list of OTC deals associated with the user.

Success Response (200 OK)​

{
    "data": [
        {
            "deal_id": "number",
            "token_id": "string",
            "token_name": "string",
            "token_symbol": "string",
            "quantity": "number",
            "available_quantity": "number",
            "price": {
                "amount": "number",
                "decimal": "number",
                "symbol": "string"
            },
            "seller_id": "string",
            "seller_name": "string",
            "buyer_id": "string",
            "buyer_name": "string",
            "deal_type": "string",
            "status": "string",
            "expires_at": "string",
            "created_at": "string",
            "updated_at": "string"
        }
    ],
    "total": "number",
    "page": 1,
    "per_page": 10
}

Example​

Request​

curl "\{\{baseUrl\}\}/v2/users/680c02896d91ca0145cfeb81/otcs?page=1&per_page=10" \
  -H "Authorization: Bearer \{\{token\}\}"

Response​

{
    "data": [
        {
            "deal_id": 12,
            "token_id": "68ae06cfcccf4e8fc19362d1",
            "token_name": "Real Estate Token",
            "token_symbol": "RET",
            "quantity": 50,
            "available_quantity": 30,
            "price": {
                "amount": 12.0,
                "decimal": 6,
                "symbol": "USDT"
            },
            "seller_id": "680c02896d91ca0145cfeb81",
            "seller_name": "John Doe",
            "buyer_id": null,
            "buyer_name": null,
            "deal_type": "sell",
            "status": "active",
            "expires_at": "2024-02-15T10:30:00Z",
            "created_at": "2024-01-15T10:30:00Z",
            "updated_at": "2024-01-15T10:30:00Z"
        }
    ],
    "total": 1,
    "page": 1,
    "per_page": 10
}

Error Responses​

400 Bad Request​

{
    "error": "Invalid request parameters"
}

401 Unauthorized​

{
    "error": "Authentication required"
}

403 Forbidden​

{
    "error": "Access denied"
}

404 Not Found​

{
    "error": "User not found"
}

500 Internal Server Error​

{
    "error": "Internal server error"
}