Skip to content
Clear Street Clear Street
Get started
API Reference

Shared

ModelsExpand Collapse
APIError { code, message, details }

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

code: number

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

formatint32
minimum0
message: string

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

details?: Array<Record<string, unknown>>

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

BaseResponse { metadata, error }
metadata: ResponseMetadata { request_id, next_page_token, page_number, 3 more }

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

request_id: string

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

next_page_token?: string | null

Base64URL-encoded pagination token containing limit and offset

formatbyte
page_number?: number | null

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

formatint32
minimum0
previous_page_token?: string | null

Base64URL-encoded pagination token containing limit and offset

formatbyte
total_items?: number | null

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

formatint64
minimum0
total_pages?: number | null

Total number of pages available.

formatint32
minimum0
error?: APIError { code, message, details } | null

Structured error details when the request is unsuccessful.

code: number

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

formatint32
minimum0
message: string

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

details?: Array<Record<string, unknown>>

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

ResponseMetadata { request_id, next_page_token, page_number, 3 more }

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.

request_id: string

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

next_page_token?: string | null

Base64URL-encoded pagination token containing limit and offset

formatbyte
page_number?: number | null

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

formatint32
minimum0
previous_page_token?: string | null

Base64URL-encoded pagination token containing limit and offset

formatbyte
total_items?: number | null

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

formatint64
minimum0
total_pages?: number | null

Total number of pages available.

formatint32
minimum0