Skip to content
Clear Street Clear Street Clear Street
Start Trading
API Reference

Shared

ModelsExpand Collapse
class ApiError:

A direct mapping of tonic::Status, for use in HTTP responses.

long code

The error code is used to identify the nature of the error. It corresponds to an HTTP status code.

formatint32
minimum0
String message

A human-readable message providing more details about the error.

Optional<List<Detail>> details

Additional error details, if any. This can include structured information such as field violations or error metadata.

class BaseResponse:

Response metadata, including the request ID and optional pagination info.

String requestId

A unique ID for this request, generated upon ingestion of the request.

Optional<String> nextPageToken

Base64URL-encoded pagination token

formatbyte
Optional<Long> pageNumber

Pagination. Included if this was a GET (list) response

formatint32
minimum0
Optional<String> previousPageToken

Base64URL-encoded pagination token

formatbyte
Optional<Long> totalItems

Total number of items available (not just in this page).

formatint64
minimum0
Optional<Long> totalPages

Total number of pages available.

formatint32
minimum0
Optional<ApiError> error

Structured error details when the request is unsuccessful.

long code

The error code is used to identify the nature of the error. It corresponds to an HTTP status code.

formatint32
minimum0
String message

A human-readable message providing more details about the error.

Optional<List<Detail>> details

Additional error details, if any. This can include structured information such as field violations or error metadata.

class ResponseMetadata:

Metadata for the response. This will always contain a request ID which can be used to identify the request to Clear Street for tracing, and optionally may include pagination data.

String requestId

A unique ID for this request, generated upon ingestion of the request.

Optional<String> nextPageToken

Base64URL-encoded pagination token

formatbyte
Optional<Long> pageNumber

Pagination. Included if this was a GET (list) response

formatint32
minimum0
Optional<String> previousPageToken

Base64URL-encoded pagination token

formatbyte
Optional<Long> totalItems

Total number of items available (not just in this page).

formatint64
minimum0
Optional<Long> totalPages

Total number of pages available.

formatint32
minimum0