Tickerdevelopers

Shared schemas

Response wrappers, pagination, and error types used across the API.

ClassicPaging

Classic page-based pagination response

{
  "pageSize": integer,
  "pageNumber": integer,
  "pageTotal": integer,
  "itemTotal": integer,
  "latestCursor": string
}
pageSizeinteger

Number of items per page

pageNumberinteger

Current page number (1-indexed)

pageTotalinteger

Total number of pages

itemTotalinteger

Total number of items matching the query

latestCursorstring

Cursor of the newest item in the response. Use as sinceCursor to poll for new items.

CursorPaging

Cursor-based pagination response

{
  "pageSize": integer,
  "nextCursor": string | null,
  "latestCursor": string
}
pageSizeinteger

Number of items per page

nextCursorstring | null

Cursor to request the next page, or null if no more results

latestCursorstring

Cursor of the newest item in the response. Use as sinceCursor to poll for new items.

ErrorDetail

Error details

{
  "message": string,
  "hint": string
}
messagestring

Human-readable error message

example: Pagination conflict
hintstring

Suggestion for resolving the error

example: Use either pageCursor or pageNumber, not both.

ErrorResponse

Error response wrapper

{
  "error": ErrorDetail
}

Error details

Meta

Response metadata (information about the data, such as pagination)

{
  "paging": Paging
}
pagingPaging

Pagination response. Format depends on which parameter was used: pageCursor → CursorPaging, pageNumber → ClassicPaging, sinceCursor → SinceCursorPaging.

Paging

Pagination response. Format depends on which parameter was used: pageCursor → CursorPaging, pageNumber → ClassicPaging, sinceCursor → SinceCursorPaging.

SinceCursorPaging

Response for sinceCursor polling. Returns items newer than the provided cursor. 

{
  "pageSize": integer,
  "latestCursor": string,
  "count": integer,
  "hasMore": boolean
}
pageSizeinteger

Maximum items per response

latestCursorstring

Cursor of the newest item returned. Use this value as sinceCursor in the next poll. If no new items, echoes back the original sinceCursor value.

countinteger

Number of items returned in this response

hasMoreboolean

True if more items exist beyond pageSize. When true, the response contains the newest pageSize items but older new items were truncated.