Get event

Use this operation for get event. Follow the markets and trading guide for the complete workflow.

Markets and trading guide · All endpoints · SDK: getEvent

Authentication

Server-to-server HMAC. Your key selects the partner; your backend must authorize the end user.

CRISP enables access to the features agreed for your integration. Contact CRISP if an enabled feature returns an access error.

Idempotency-Key: Not required by this operation. Signing and authentication →

Request fields

Required means the field must be present. Nullable means an explicit JSON null is allowed; it does not mean optional.

Path parameters

Field	Type / presence	Description and constraints
`id`	`string` Required Non-null	—

Query parameters

Field	Type / presence	Description and constraints
`locale`	`string` Optional Non-null	Allowed: "en", "zh", "zh-hant", "ja"

Header parameters

No operation-specific headers. The HMAC headers above still apply.

JSON body

No request body.

Illustrative identifiers only: replace them with resources from your integration. Keep credentials on your backend. HTTP placeholders must be signed; the SDK signs automatically. Financial intent keys must be persisted and unique per new action.

GET /v1/events/example
Host: partner-api.crisp.trade
X-Crisp-Partner-Key: <server-key-id>
X-Crisp-Timestamp: <fresh-ISO-8601-UTC-timestamp>
X-Crisp-Nonce: <fresh-unique-nonce>
X-Crisp-Signature: <computed-base64-HMAC>

Response fields

HTTP responses use the envelope below. SDK calls expose its payload as result.data, with HTTP status and request metadata on the SDK wrapper.

200 · Success

Data payload

Field Type / presence Description and constraints

event

object

Required

Non-null

Venue-owned JSON extension; fields are not a stable CRISP contract. Handle missing fields.

localization

object

Optional

Non-null

Expand the structure below.

localization: expand fields

Field Type / presence Description and constraints

locale

string

Required

Non-null

Allowed: "en", "zh", "zh-hant", "ja"

fallbackLocale

string

Required

Non-null

Allowed: "en"

source

string

Required

Non-null

Allowed: "upstream", "unavailable"

events

array<object>

Required

Non-null

Expand the structure below.

events: expand item fields

Field Type / presence Description and constraints

eventId

string

Required

Non-null

—

title

string | null

Required

Nullable

Expand the structure below.

title: expand fields

string

seriesTitle

string | null

Optional

Nullable

Expand the structure below.

seriesTitle: expand fields

string

markets

array<object>

Required

Non-null

Expand the structure below.

markets: expand item fields

Field Type / presence Description and constraints

marketId

string

Required

Non-null

—

sourceMarketId

string

Required

Non-null

—

title

string | null

Required

Nullable

Expand the structure below.

title: expand fields

string

groupItemTitle

string | null

Required

Nullable

Expand the structure below.

groupItemTitle: expand fields

string

outcomes

array<object>

Required

Non-null

Expand the structure below.

outcomes: expand item fields

Field	Type / presence	Description and constraints
`tokenId`	`string` Required Non-null	Outcome token identifier. Keep as a string to avoid integer precision loss. Validation pattern `^(0\|[1-9]\d{0,100})$`
`index`	`integer` Required Non-null	minimum: 0
`label`	`string` Required Non-null	—

Additional fields are not allowed in this object.

tags

array<object>

Required

Non-null

Expand the structure below.

tags: expand item fields

Field	Type / presence	Description and constraints
`id`	`string` Required Non-null	—
`label`	`string` Required Non-null	—

Additional fields are not allowed in this object.

markets

array<object>

Required

Non-null

Expand the structure below.

markets: expand item fields

Field Type / presence Description and constraints

marketId

string

Required

Non-null

—

sourceMarketId

string

Required

Non-null

—

title

string | null

Required

Nullable

Expand the structure below.

title: expand fields

string

groupItemTitle

string | null

Required

Nullable

Expand the structure below.

groupItemTitle: expand fields

string

outcomes

array<object>

Required

Non-null

Expand the structure below.

outcomes: expand item fields

Field	Type / presence	Description and constraints
`tokenId`	`string` Required Non-null	Outcome token identifier. Keep as a string to avoid integer precision loss. Validation pattern `^(0\|[1-9]\d{0,100})$`
`index`	`integer` Required Non-null	minimum: 0
`label`	`string` Required Non-null	—

Additional fields are not allowed in this object.

missingEventIds

array<string>

Required

Non-null

Expand the structure below.

missingEventIds: expand item fields

string

missingMarketIds

array<string>

Required

Non-null

Expand the structure below.

missingMarketIds: expand item fields

string

Additional fields are not allowed in this object.

Full HTTP envelope

Field Type / presence Description and constraints

data

object

Required

Non-null

Expand the structure below.

data: expand fields

Field Type / presence Description and constraints

event

object

Required

Non-null

Venue-owned JSON extension; fields are not a stable CRISP contract. Handle missing fields.

localization

object

Optional

Non-null

Expand the structure below.

localization: expand fields

Field Type / presence Description and constraints

locale

string

Required

Non-null

Allowed: "en", "zh", "zh-hant", "ja"

fallbackLocale

string

Required

Non-null

Allowed: "en"

source

string

Required

Non-null

Allowed: "upstream", "unavailable"

events

array<object>

Required

Non-null

Expand the structure below.

events: expand item fields

Field Type / presence Description and constraints

eventId

string

Required

Non-null

—

title

string | null

Required

Nullable

Expand the structure below.

title: expand fields

string

seriesTitle

string | null

Optional

Nullable

Expand the structure below.

seriesTitle: expand fields

string

markets

array<object>

Required

Non-null

Expand the structure below.

markets: expand item fields

Field Type / presence Description and constraints

marketId

string

Required

Non-null

—

sourceMarketId

string

Required

Non-null

—

title

string | null

Required

Nullable

Expand the structure below.

title: expand fields

string

groupItemTitle

string | null

Required

Nullable

Expand the structure below.

groupItemTitle: expand fields

string

outcomes

array<object>

Required

Non-null

Expand the structure below.

outcomes: expand item fields

Field	Type / presence	Description and constraints
`tokenId`	`string` Required Non-null	Outcome token identifier. Keep as a string to avoid integer precision loss. Validation pattern `^(0\|[1-9]\d{0,100})$`
`index`	`integer` Required Non-null	minimum: 0
`label`	`string` Required Non-null	—

Additional fields are not allowed in this object.

tags

array<object>

Required

Non-null

Expand the structure below.

tags: expand item fields

Field	Type / presence	Description and constraints
`id`	`string` Required Non-null	—
`label`	`string` Required Non-null	—

Additional fields are not allowed in this object.

markets

array<object>

Required

Non-null

Expand the structure below.

markets: expand item fields

Field Type / presence Description and constraints

marketId

string

Required

Non-null

—

sourceMarketId

string

Required

Non-null

—

title

string | null

Required

Nullable

Expand the structure below.

title: expand fields

string

groupItemTitle

string | null

Required

Nullable

Expand the structure below.

groupItemTitle: expand fields

string

outcomes

array<object>

Required

Non-null

Expand the structure below.

outcomes: expand item fields

Field	Type / presence	Description and constraints
`tokenId`	`string` Required Non-null	Outcome token identifier. Keep as a string to avoid integer precision loss. Validation pattern `^(0\|[1-9]\d{0,100})$`
`index`	`integer` Required Non-null	minimum: 0
`label`	`string` Required Non-null	—

Additional fields are not allowed in this object.

missingEventIds

array<string>

Required

Non-null

Expand the structure below.

missingEventIds: expand item fields

string

missingMarketIds

array<string>

Required

Non-null

Expand the structure below.

missingMarketIds: expand item fields

string

Additional fields are not allowed in this object.

requestId

string

Required

Non-null

Request correlation ID for debugging and support.

Additional fields are not allowed in this object.

Response example

Schema illustration, not live account data. Null means unavailable or not applicable, never an invented zero. Empty arrays do not imply the endpoint always returns no results.

200 response JSON

{
  "data": {
    "event": {}
  },
  "requestId": "example-request-id"
}

Errors and recovery

Status	Meaning
`400`	Inspect error.code and retain the original financial intent.
`401`	Inspect error.code and retain the original financial intent.
`403`	Inspect error.code and retain the original financial intent.
`404`	Not visible for this account. A recovery lookup miss is not proof that an in-flight submission failed.
`409`	Inspect error.code and retain the original financial intent.
`429`	Inspect error.code and retain the original financial intent.
`500`	Inspect error.code and retain the original financial intent.
`502`	Inspect error.code and retain the original financial intent.
`503`	Inspect error.code and retain the original financial intent.

Inspect the error code and outcomeUnknown, not just the HTTP status. Preserve the original intent after financial uncertainty. Read-only retries should honor Retry-After. Recovery workflow →

Error response fields

Field Type / presence Description and constraints

error

object

Required

Non-null

Expand the structure below.

error: expand fields

Field	Type / presence	Description and constraints
`code`	`string` Required Non-null	—
`message`	`string` Required Non-null	—
`requestId`	`string` Required Non-null	Request correlation ID for debugging and support.

Additional fields are not allowed in this object.

Raw contract

OpenAPI download · Advanced schema and legacy anchor

Authentication

Request fields

Path parameters

Query parameters

Header parameters

JSON body

Request example

Response fields

200 · Success

Data payload

Response example

Errors and recovery

Raw contract

On this page