Trades

API Endpoints For Trades

List of Trade Endpoints
Endpoint
Description
Type
​/trades​
return all trades
GET
​/trades/:id​
return trade by :id
GET
​/trades/search​
search trades
POST
GET - Return All Trades
Endpoint
GET /trades
Query Parameters
Name
Type
Description
Required
page
int
The number of the page that will be returned.
No
limit
int
The number of resources per page.
No
orderBy
string
Type by which should order resources.
No
transform
boolean
If returns modified or raw data.
No
Example
curl https://api.protokol.com/api/nft/exchange/trades
Response
{
  "meta": {
    "totalCountIsEstimate": true,
    "count": 1,
    "pageCount": 1,
    "totalCount": 1,
    "next": null,
    "previous": null,
    "self": "/nft/exchange/trades?page=1&limit=100&transform=true",
    "first": "/nft/exchange/trades?page=1&limit=100&transform=true",
    "last": "/nft/exchange/trades?page=1&limit=100&transform=true"
  },
  "data": [
    {
      "id": "b55750470dfb3e98a8a7acd4d1e933ab20db1ddd18343b7f6ddaa2a4395a9d06",
      "senderPublicKey": "03287bfebba4c7881a0509717e71b34b63f31e40021c321f89ae04f84be6d6ac37",
      "completedTrade": {
        "auctionId": "4acf50de691a6173a07ccb769381003685ebbdb2dbc9d7601baa882cc9bbfd56",
        "bidId": "405d07d0b41c7a279cab832c267d3be0e5947bdf89156103865e8a290d4e907a"
      },
      "timestamp": {
        "epoch": 105743104,
        "unix": 1595844304,
        "human": "2020-07-27T10:05:04.000Z"
      }
    }
  ]
}
GET - Return Trade By Id
Endpoint
GET /trades/{id}
Path Parameters
Name
Type
Description
Required
id
string
The identifier of the trade to be retrieved.
Yes
transform
boolean
If returns modified or raw data.
No
Example
curl https://api.protokol.com/api/nft/exchange/trades/e80a40379f9dc26a7be1b7302e4f2f1129ae6335c538a41cf29e9f242cfaee0d
Response
{
  "data": {
    "id": "993faf758740972af07b67892e1ff2a66f1467c9203020bdb65f8a0a533942e7",
    "senderPublicKey": "022f2978d57f95c021b9d4bf082b482738ce392bcf6bc213710e7a21504cfeb5a0",
    "completedTrade": {
      "auction": {
        "id": "4166ebfa58824bf774dbd1f70c04a22adf3f77f30ce2f32ae69f98b302b5752f",
        "nftId": "a6273964d15a1de37792497bf15e12e67898c7217a680cbf2e152cccc33e5182",
        "startAmount": "999",
        "expiration": {
          "blockHeight": 1000000
        }
      },
      "bid": {
        "id": "249010d96a54a8fbd14b1d2b5d3d12abc56edf0843f11a9c84d0fd8a2385625a",
        "auctionId": "4166ebfa58824bf774dbd1f70c04a22adf3f77f30ce2f32ae69f98b302b5752f",
        "bidAmount": "12223"
      }
    },
    "timestamp": {
      "epoch": 105746776,
      "unix": 1595847976,
      "human": "2020-07-27T11:06:16.000Z"
    }
  }
}
POST - Search Trades
Endpoint
POST /trades/search
Query Parameters
Name
Type
Description
Required
page
int
The number of the page that will be returned.
No
limit
int
The number of resources per page.
No
orderBy
string
Type by which should order resources.
No
Body Parameters
Name
Type
Description
Required
senderPublicKey
string
Public key of a sender.
No
auctionId
string
Id of a auction.
No
bidId
string
Id of a bid.
No
Example
curl --request POST \
  --url https://api.protokol.com/api/nft/exchange/trades/search \
  --header 'content-type: application/json' \
  --data '{
	  	"senderPublicKey": "03287bfebba4c7881a0509717e71b34b63f31e40021c321f89ae04f84be6d6ac37"
}'
Response
{
  "meta": {
    "totalCountIsEstimate": true,
    "count": 1,
    "pageCount": 1,
    "totalCount": 1,
    "next": null,
    "previous": null,
    "self": "/nft/exchange/trades/search?page=1&limit=100&transform=true",
    "first": "/nft/exchange/trades/search?page=1&limit=100&transform=true",
    "last": "/nft/exchange/trades/search?page=1&limit=100&transform=true"
  },
  "data": [
    {
      "id": "b55750470dfb3e98a8a7acd4d1e933ab20db1ddd18343b7f6ddaa2a4395a9d06",
      "senderPublicKey": "03287bfebba4c7881a0509717e71b34b63f31e40021c321f89ae04f84be6d6ac37",
      "completedTrade": {
        "auctionId": "4acf50de691a6173a07ccb769381003685ebbdb2dbc9d7601baa882cc9bbfd56",
        "bidId": "405d07d0b41c7a279cab832c267d3be0e5947bdf89156103865e8a290d4e907a"
      },
      "timestamp": {
        "epoch": 105743104,
        "unix": 1595844304,
        "human": "2020-07-27T10:05:04.000Z"
      }
    }
  ]
}

Exchange-API Endpoints - Previous

Bids

Next - Exchange-API Endpoints

Configurations

Last updated 4 months ago

Endpoint	Description	Type
/trades	return all trades	GET
/trades/:id	return trade by :id	GET
/trades/search	search trades	POST

Name	Type	Description	Required
page	int	The number of the page that will be returned.	No
limit	int	The number of resources per page.	No
orderBy	string	Type by which should order resources.	No
transform	boolean	If returns modified or raw data.	No

Name	Type	Description	Required
id	string	The identifier of the trade to be retrieved.	Yes
transform	boolean	If returns modified or raw data.	No