Events

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

The Event Model

The event model chronicles the various activities associated with tokens on the ArkProject platform. Each event is tied to a specific token_address and token_id, pinpointing the exact token involved in the event. The event_type describes the nature of the event, such as a sale, transfer, or listing.

Properties

Name
token_address
Type
string
Description
Unique identifier for the token contract.
Name
token_id
Type
string
Description
Token ID.
Name
current_owner
Type
string
Description
The address of the owner of the token.
Name
current_price
Type
string
Description
Price of the token.
Name
history
Type
array
Description
Events's array of the token.
Name
history.event_type
Type
string
Description
Type of the event, it can be: Listing, Auction, Offer or CollectionOffer.
Name
history.event_timestamp
Type
string
Description
Timestamp of the event.
Name
history.order_status
Type
string
Description
Order status, it can be: PLACED, FULFILLED, CANCELLED, EXECUTED.
Name
history.previous_owner
Type
string
Description
Previous owner of the token, when an offer is EXECUTED.
Name
history.new_owner
Type
string
Description
New owner of the token, when an offer is EXECUTED.
Name
history.amount
Type
string
Description
Amount of the token.
Name
history.canceled_reason
Type
string
Description
Why the event has been canceled.

GET/token/{contract_address}/{token_id}/history

Retrieve the event for a specific token

This endpoint allows you to retrieve the events of a specific token

Path parameters

Name
contract_address
Type
string
Description
Hexadecimal address of the contract.
Name
token_id
Type
string
Description
Hexadecimal or decimal token ID.

Request

GET

/token/{contract_address}/{token_id}/history

curl https://api-orderbook.arkproject.dev/token/{contract_address}/{token_id}/history

Response

{
    "result": {
        "contract_address": "0x05dbdedc203e92749e2e746e2d40a768d966bd243df04a6b712e222bc040a9af",
        "token_id": "0x000000000000000000000000000000000000000000000000000000000098db9a",
        "current_owner": "0x00a69e64b09ef9830305c3e3166e2b42b3b38edd054c18a9105974f7eb949826",
        "history": [
            {
                "event_type": "Listing",
                "event_timestamp": 1625247600,
                "order_status": "EXECUTED",
                "previous_owner": null,
                "new_owner": "0x00a69e64b09ef9830305c3e3166e2b42b3b38edd054c18a9105974f7eb949826",
                "amount": "1000",
                "canceled_reason": null
            },
            {
                "event_type": "Offer",
                "event_timestamp": 1625348600,
                "order_status": "EXECUTED",
                "previous_owner": "0x00a69e64b09ef9830305c3e3166e2b42b3b38edd054c18a9105974f7eb949826",
                "new_owner": "0x02b69e64b09ef9830305c3e3166e2b42b3b38edd054c18a9105974f7eb949827",
                "amount": "1200",
                "canceled_reason": null
            }
        ]
    }
}