Events

Events capture significant activities related to tokens, offering a detailed view of transactions, trades, and other pivotal moments.

Event Model

The Event Model provides a structured overview of token-related activities, detailing properties like contract details, transaction identifiers, and participant addresses for efficient integration and analysis.

Properties

  • Name
    contract_address
    Type
    string
    Description

    Address of the token involved in the event.

  • Name
    contract_type
    Type
    string
    Description

    Type of the contract (e.g., ERC721, ERC1155).

  • Name
    event_id
    Type
    string
    Description

    Unique identifier of the event.

  • Name
    event_type
    Type
    string
    Description

    Type of the event (e.g., sale, transfer, mint).

  • Name
    from_address
    Type
    string
    Description

    Address of the sender.

  • Name
    timestamp
    Type
    timestamp
    Description

    Unix timestamp of the event.

  • Name
    to_address
    Type
    string
    Description

    Address of the receiver.

  • Name
    token_id
    Type
    string
    Description

    ID of the token involved in the event.

  • Name
    token_id_hex
    Type
    string
    Description

    Hexadecimal representation of the token ID.

  • Name
    transaction_hash
    Type
    string
    Description

    Hash of the transaction associated with the event.


GET/v1/events/{contract_address}

Retrieve Contract Events

This endpoint allows you to retrieve a paginated list of all events associated with a specific contract address.

Path parameters

  • Name
    contract_address
    Type
    string
    Description

    Hexadecimal address of the contract.

Query string parameters

  • Name
    cursor
    Type
    string
    Description

    The cursor to get the next page. Retrieved from previous request that may be paginated.

  • Name
    limit
    Type
    number
    Description

    The limit on the number of items returned per request, defaulting to 100, with a 1MB data cap. (Refer to the pagination section below for more details.)

Request

GET
/v1/events/{contract_address}
curl -G https://api.arkproject.dev/v1/events/{contract_address} \
-H "x-api-key: <INSERT_API_KEY_HERE>"

Response

{
  "cursor": null,
  "result": [
    {
      "contract_address": "0x060582df2cd4ad2c988b11fdede5c43f56a432e895df255ccd1af129160044b8",
      "contract_type": "ERC721",
      "event_id": "0x007c8b7d0ac3d95871c00b01afc134cb4eda8bcb470325ce7def755a8276f32a",
      "event_type": "mint",
      "from_address": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "timestamp": 1706896016,
      "to_address": "0x051394bb90426950071a0f3fd1ce26909299ee00b5307b5b198d487b9fbd3ee6",
      "token_id": "856292",
      "token_id_hex": "0x00000000000000000000000000000000000000000000000000000000000d10e4",
      "transaction_hash": "0x055678c0ca822151f586cdc476cdb85d26a6cf3a1e8e9abc8cf3baebaaf2db9d"
    },
    {...},
    {...}
  ]
}

GET/v1/events/{contract_address}/{token_id}

Retrieve events for a specific token

This endpoint allows you to retrieve events associated with a specific token by providing its contract address and token id.

Path parameters

  • Name
    contract_address
    Type
    string
    Description

    Hexadecimal address of the contract.

  • Name
    token_id
    Type
    string
    Description

    Hexadecimal or decimal token ID.

Query string parameters

  • Name
    cursor
    Type
    string
    Description

    The cursor to get the next page. Retrieved from previous request that may be paginated.

  • Name
    limit
    Type
    string
    Description

    The limit on the number of items returned per request, defaulting to 100, with a 1MB data cap. (Refer to the pagination section below for more details.)

Request

GET
/v1/events/{contract_address}/{token_id}
curl https://api.arkproject.dev/v1/events/{contract_address}/{token_id} \
-H "x-api-key: <INSERT_API_KEY_HERE>"

Response

{
    "cursor": null,
    "result": [
        {
            "timestamp": 1706896016,
            "from_address": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "to_address": "0x051394bb90426950071a0f3fd1ce26909299ee00b5307b5b198d487b9fbd3ee6",
            "contract_address": "0x060582df2cd4ad2c988b11fdede5c43f56a432e895df255ccd1af129160044b8",
            "transaction_hash": "0x055678c0ca822151f586cdc476cdb85d26a6cf3a1e8e9abc8cf3baebaaf2db9d",
            "token_id": "856292",
            "token_id_hex": "0x00000000000000000000000000000000000000000000000000000000000d10e4",
            "contract_type": "ERC721",
            "event_type": "mint",
            "event_id": "0x007c8b7d0ac3d95871c00b01afc134cb4eda8bcb470325ce7def755a8276f32a"
        },
        {...},
        {...}
    ]
}