/messari/assets/unlocks

POST /api/messari/assets/unlocks

Price: 1 credit

Get scheduled and historical token unlock events for a crypto asset

How to use it

Get token unlock events for a crypto asset by its slug or ticker symbol, covering both past and upcoming unlocks within the chosen window. Each event has the unlock date, status, priority/impact/urgency, the native token amount unlocked, the percent of supply it represents, and the asset. Use it to track vesting schedules and upcoming supply unlocks.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• asset string required — Asset slug or ticker symbol (examples: "arbitrum", "optimism", "ARB"; minLength: 1)
• days_back integer — Days of past unlock events to include (default: 90; min: 0)
• days_ahead integer — Days of upcoming unlock events to include (default: 365; min: 0)

Response

• @type string (default: "MessariTokenUnlock")
• date string nullable
• status string nullable
• priority string nullable
• impact string nullable
• importance string nullable
• urgency string nullable
• amount_native number nullable
• percent_of_supply number nullable
• asset_id string nullable
• asset_name string nullable
• asset_slug string nullable
• asset_symbol string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Asset not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.