Skip to main content

public/get-instrument-lifecycle-states

GET 
/public/get-instrument-lifecycle-states
Returns a paginated list of instrument lifecycle state changes. Use this endpoint to track when instruments transition between states (e.g., from Suspended to Closed).

Request​

Query Parameters

    event_symbol string

    Filter by event symbol. Returns only lifecycle states for instruments belonging to this event.

    limit int32

    Maximum number of records to return per page. Defaults to 100.

    since int64

    Unix timestamp in nanoseconds. Returns records updated after this time. Defaults to 0.

    cursor string

    Pagination cursor from the previous response. Omit for the first request.

Success.
Schema
    id int64

    Echoed request id

    method string

    Method invoked

    code int32

    0 = success; non-zero indicates error (reason code).

    result object
    Present when code === 0. Instrument lifecycle states (data array).
    data object[]
    List of instrument lifecycle state changes.
  • Array [
    • symbol string

    Unique instrument symbol.

    inst_type string

    Instrument type.

    state string

    Current lifecycle state of the instrument.

    previous_state string

    Previous lifecycle state before the transition.

    lifecycle_change_reason string

    Reason for the lifecycle state change.

    last_updated_time int64

    Unix timestamp in nanoseconds when the state was last updated.

  • ]
    • next_cursor string

    Cursor for pagination. Use this value in the cursor parameter of the next request.

    message string

    Response message. Contains additional reason when code !== 0.

    original string

    Present when code !== 0.