Base Message
Each event message that is sent by the Stream API will include the following three fields:
Field | Description |
|---|---|
| Signifies the specific event that the message is representing. |
| Timestamp that represents the time at which the message was sent to the client. |
| Event-specific set of data. |
Example
{
"event_type": "item_metadata_update",
"sent_at": "2022-04-25T23:32:14.486643+00:00",
"payload": {
"collection": { "slug": "doodles-official"},
"item": {
"nft_id":"ethereum/0x8a90cab2b38dba80c64b7734e58ee1db38b8992e/222",
"permalink":"https://opensea.io/assets/0x8a90cab2b38dba80c64b7734e58ee1db38b8992e/222",
"chain": { "name": "ethereum" },
"metadata": {
"name": "Doodle #222",
"description": "A community-driven collectibles project featuring art by Burnt Toast. Doodles come...",
"image_url": "https://lh3.googleusercontent.com/R7wtoDNdmM7GhTvVjr4JGA6q60z44Hn2nIymPjAEXcjnD8oBPxQYPA1GkrCnvepPM1Sc8DlIHZql4Yucj4ger1jnWmxmuRFwIC_JRw",
"animation_url": null,
"metadata_url": "https://opensea.mypinata.cloud/ipfs/QmPMc4tcBsMqLRuCQtPmPe84bpSjrC3Ky7t3JWuHXYB4aS/222",
},
},
"payload_specific_field1": {},
"payload_specific_field2": {},
}
}
Item Listed Payload
Messages that represent item listing events will include an event_type of item_listed.
Example
{
"event_type": "item_listed",
"sent_at": "2022-04-25T23:32:14.486643+00:00",
"payload": {
"event_timestamp": "2022-04-21T16:46:46.240222+00:00",
"base_price": "24840000000000000000",
"expiration_date": "2022-05-17T04:36:50.000000+00:00",
"is_private": false,
"listing_date": "2022-04-21T17:10:54.000000+00:00",
"listing_type": "dutch",
"maker": { "address": "0xc4b08a8009763dab8c2fb44a59d8f1c23e8c11e5" },
"payment_token": {
"address": "0x0000000000000000000000000000000000000000",
"decimals": 18,
"eth_price": "1",
"name": "Ether",
"symbol": "ETH",
"usd_price": "3097.57"
},
"quantity": 1,
"taker": null
}
}
Item Sold Payload
Messages that represent item listing events will include an event_type of item_sold.
Example
{
"event_type": "item_sold",
"sent_at": "2022-04-25T23:32:14.486643+00:00",
"payload": {
"event_timestamp": "2022-04-21T16:46:46.240222+00:00",
"closing_date": "2022-04-21T18:26:36.000000+00:00",
"is_private": false,
"listing_type": null,
"maker": { "address": "0x9e7b8c91eca1139c41eead94eeb8bc21bd2725ab" },
"payment_token": {
"address": "0x7ceb23fd6bc0add59e62ac25578270cff1b9f619",
"decimals": 18,
"eth_price": "1",
"name": "Ether",
"symbol": "ETH",
"usd_price": "3067.19"
},
"quantity": 1,
"sale_price": 5000000000000000,
"taker": { "address": "0x338571a641d8c43f9e5a306300c5d89e0cb2cfaf" },
"transaction": {
"hash": "0x57135fca40b927fbd741f5a21626c1c4c84e7c1036bb50d3158e2fa62a80c941",
"timestamp": "2022-04-21T18:26:36.000000+00:00"
}
}
}
Item Transferred Payload
Messages that represent item listing events will include an event_type of item_transferred.
Example
{
"event_type": "item_transferred",
"sent_at": "2022-04-25T23:32:14.486643+00:00",
"payload": {
"event_timestamp": "2022-04-21T16:46:46.240222+00:00",
"transaction": {
"timestamp": "2022-04-21T16:46:46.240222+00:00",
"hash": "0x7c5a693a803fbc9529623244f70be2aa4d1fd78d8927810221380088a5db8877"
},
"from_account": { "address": "0xe1fd04ffe70bd2230ec4031b09681c3bd66af8b6" },
"to_account": { "address": "0x3dcf05d734a8999f2ae181df4bfe7aca86ea4c4a" },
"quantity": 1
}
}
Item Metadata Update Payload
Messages that represent item listing events will include an event_type of item_metadata_updated.
Example
{
"event_type": "item_metadata_updated",
"sent_at": "2022-04-25T23:32:14.486643+00:00",
"payload": {
"name": "Doodle #222",
"description": "A community-driven collectibles project featuring art by Burnt Toast. Doodles come...",
"image_preview_url": "https://lh3.googleusercontent.com/R7wtoDNdmM7GhTvVjr4JGA6q60z44Hn2nIymPjAEXcjnD8oBPxQYPA1GkrCnvepPM1Sc8DlIHZql4Yucj4ger1jnWmxmuRFwIC_JRw",
"animation_url": null,
"background_color": "#000000",
"metadata_url": "https://opensea.mypinata.cloud/ipfs/QmPMc4tcBsMqLRuCQtPmPe84bpSjrC3Ky7t3JWuHXYB4aS/222",
"traits": []
}
}
Item Cancelled Payload
Messages that represent item listing events will include an event_type of item_cancelled.
Example
{
"event_type": "item_cancelled",
"sent_at": "2022-04-25T23:32:14.486643+00:00",
"payload": {
"event_timestamp": "2022-04-21T16:46:46.240222+00:00",
"listing_type": null,
"payment_token": {
"address": "0x0000000000000000000000000000000000000000",
"decimals": 18,
"eth_price": "1",
"name": "Ether",
"symbol": "ETH",
"usd_price": "3070.02"
},
"quantity": 1,
"transaction": {
"hash": "0x5220ed591129adca7bac908b135a14fa1c88ee190cee9e88324c6af8f7c693e3",
"timestamp": "2022-04-21T18:51:43.000000+00:00"
}
}
}
Item Received Offer Payload
Messages that represent item listing events will include an event_type of item_received_offer.
Example
{
"event_type": "item_received_offer",
"sent_at": "2022-04-25T23:32:14.486643+00:00",
"payload": {
"event_timestamp": "2022-04-21T16:46:46.240222+00:00",
"base_price:": "12245000000000000000",
"created_date": "2022-04-21T18:19:46.000000+00:00",
"expiration_date": "2022-04-21T20:02:06.000000+00:00",
"maker": { "address": "0x4fc1ee71ec160b6975f615ecec52e295cea1b60f" },
"payment_token": {
"address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
"decimals": 18,
"eth_price": "1",
"name": "Wrapped Ether",
"symbol": "WETH",
"usd_price": "3067.19"
},
"quantity": 1,
"taker": null
}
}
Item Received Bid Payload
Messages that represent item listing events will include an event_type of item_received_bid.
Example
{
"event_type": "item_received_bid",
"sent_at": "2022-04-25T23:32:14.486643+00:00",
"payload": {
"event_timestamp": "2022-04-21T16:46:46.240222+00:00",
"base_price": "5000000000000000",
"created_date": "2022-04-21T18:26:31.731160+00:00",
"expiration_date": "2022-05-17T09:40:03.000000+00:00",
"maker": { "address": "0x338571a641d8c43f9e5a306300c5d89e0cb2cfaf" },
"payment_token": {
"address": "0x7ceb23fd6bc0add59e62ac25578270cff1b9f619",
"decimals": 18,
"eth_price": "1",
"name": "Ether",
"symbol": "ETH",
"usd_price": "3067.19"
},
"quantity": 1,
"taker": { "address": "0x9e7b8c91eca1139c41eead94eeb8bc21bd2725ab" }
}
}