Activities
The route returns real-time aggregated market activities across all collections of your market
Kinds Definition
list
1
Seller listed an inscription
Yes
delist
2
Seller cancelled listing the inscription
Yes
buying_broadcasted
3
Buyer purchased and txn broadcasted by platform
Yes
Tx ID
offer_placed
4
Buyer placed bid to a certain inscription
Only if you have bidding function
offer_cancelled
5
Buyer cancelled the bid
Only if you have bidding function
offer_accepted_broadcasted
6
Inscription owner accepted the bid and txn broadcasted by platform
Only if you have bidding function
Tx ID
proxy_buying
7
Buyer purchased the listings from other platform via Ordyssey
No, Ordyssey will maintain it
Tx ID
proxy_listing
8
Seller listed an inscription from Ordyssey to other platform
No, Ordyssey will maintain it
transfer
9
An Inscription changing its owner on Bitcoin Blockchain
Only if you have a Bitcoin Tx listener for Ordinals protocol
Tx ID
mint_broadcasted
10
An Inscription was inscribed and it belongs to a launchpad project/collection by the platform
Only if you have a launchpad for minting
Tx ID
Fetch activities
GET https://api.yourapi.com/v1/activities
Good to know: The Body block here means response body returns from yours, not request body from us, just for easier representation.
Query Parameters
collection_slug
string
The identifier of a certain collection to query
kinds
string[]
Query with the kind names in definition, such as list,delist,buying_broadcasted In API standard, we usually use `,` separator for array in URL
inscription_id
string
The identifier of the listed inscription, which is generated by Ordinals protocol. Such as e583ba055949cd05bb145249b20dd5076cb81d46e0bb84158a17305fcc77aa05i0
order_by
string
-timestamp
limit
int
100
offset
int
0
Headers
ordyssey_http*
string
We usually use this HTTP header to allow your server identify us, or we can engage in a discussion to provide a private API token. In certain cooperative scenarios, it is important for you to be aware that the HTTP request originates from our side for the purpose of tracking contributions.
Request Body
inscription_id*
string
The identifier of the listed inscription, which is generated by Ordinals protocol. Such as e583ba055949cd05bb145249b20dd5076cb81d46e0bb84158a17305fcc77aa05i0
seller*
string
The seller BTC address, the owner of the inscription
collection_slug
string
The identifier of the inscription's collection if it has, otherwise blank/null
timestamp*
timestamp
UTC timestamp, 1632099515
price
int
Price (in sats) by seller or bidder. For kind number 1, 3, 4, 6, 7, 8, 10, it's required, otherwise please set the blank/null value here
buyer
string
The buyer or bidder BTC address, can be blank/null value for some kinds of activities like list
kind*
string
The kind name in definition, such as list
tx_id
string
For kind number 3, 6, 7, 8, 9, 10, it has related broadcasted Tx ID, such as ad117589c3d4485b547192fe6d8a2284863e10d3900d7cbf7ab9b9049eea8db9
Otherwise please set the blank/null value here
Last updated
Was this helpful?