Events

Filters will soon be updated, there will be standardization. The change will be available from 04.12.2022 (delayed)

This is the Beta version.

Get events

get_events

GET https://beta.starknet.events/api/v1/get_events

Returns all decoded StarkNet event objects matching the conditions in the provided filter.

📝 Note: query parameter requires the name of the event.

Query Parameters

Name	Type	Description
chainId*		Enum: mainnet, testnet StarkNet chain id, given in string form.
fromBlock*	Integer	The block's number (it's height).
toBlock*	Integer	The block's number (it's height).
fromTimestamp	String<date-time>	The earliest timestamp to include in the query (RFC 3339).
toTimestamp	String<date-time>	The latest timestamp to include in the query (RFC 3339).
contract	Array of strings	From address (contract). Represented as up to 63 hex digits and leading 4 bits zeroed.
name	Array of strings	Event name.
keys	Array of strings	Event keys.
parameter	String	Event parameter. Type of Map. - parameter[name] - event parameter name, - parameter[value] - event parameter value Two values(name & value) should be given. Note: query parameter name is required.
page_number*	Integer	>=1 The page number to return.
page_size*	Integer	[ 1 .. 100 ] The number of results to return per page.

200: OK Successful response

{
  "events": [
    {
      "block_number": 0,
      "chain_id": "string",
      "contract": "string",
      "event_id": "string",
      "keys": [
        "string"
      ],
      "name": "string",
      "parameters": [
        {}
      ],
      "timestamp": "string",
      "tx_hash": "string"
    }
  ],
  "is_last_page": true,
  "page_size": 0
}

422: Unprocessable Entity Validation error

{
  "code": 0,
  "msg": "string"
}

500: Internal Server Error Internal server error

{
  "code": 0,
  "msg": "string"
}

Try this endpoint in your browser.