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

Shared

ModelsExpand Collapse
type APIError struct{…}

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

Code int64

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 []map[string, any]Optional

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

type BaseResponse struct{…}

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

RequestID string

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

NextPageToken stringOptional

Base64URL-encoded pagination token

formatbyte
PageNumber int64Optional

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

formatint32
minimum0
PreviousPageToken stringOptional

Base64URL-encoded pagination token

formatbyte
TotalItems int64Optional

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

formatint64
minimum0
TotalPages int64Optional

Total number of pages available.

formatint32
minimum0
Error APIErrorOptional

Structured error details when the request is unsuccessful.

Code int64

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 []map[string, any]Optional

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

type ResponseMetadata struct{…}

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.

RequestID string

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

NextPageToken stringOptional

Base64URL-encoded pagination token

formatbyte
PageNumber int64Optional

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

formatint32
minimum0
PreviousPageToken stringOptional

Base64URL-encoded pagination token

formatbyte
TotalItems int64Optional

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

formatint64
minimum0
TotalPages int64Optional

Total number of pages available.

formatint32
minimum0