Skip to navigation
API reference

Read match coverage

Authentication

AuthorizationBearer

Private development credential: keyId.secret; rotate/revoke through the offline operations CLI.

OR
X-RapidAPI-Proxy-Secretstring

Provider proxy credential. Customer X-RapidAPI-Key is not accepted as this secret. Approved listing, host, plan and principal required.

Path parameters

matchIdstringRequiredformat: "^mat_[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"

Headers

Idempotency-KeystringOptionalformat: "^[A-Za-z0-9_.:-]{8,128}$"

Optional client logical-operation identifier. Scoped to principal, channel and operation class. A different canonical request conflicts; expired replay returns 410. RapidAPI retries without this stable identifier are separate attempts/operations.

Query parameters

releasestringOptionalformat: "^[a-z0-9][a-z0-9-]{0,79}$"

Response headers

X-Operation-IdstringOptionalformat: "uuid"

Durable logical operation UUID; shared by keyed retries. Not a credential.

Response

Pinned release data. Missing families return an empty array and coverage reasons.
datalist of objects
metaobject or null
pageobject or null
errorobject or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
410
Gone Error
413
Content Too Large Error
414
URI Too Long Error
429
Too Many Requests Error
503
Service Unavailable Error