order-controller

getOrderById

Returns order by Id

Request
path Parameters
id
required
string (OrderId)

Order Id, has format 'ETHEREUM:${id}'

Example: ETHEREUM:0x334180be75306dab373c4eadc35355f3ce887e4e63d5dc087d7e95a98f83b4d3
Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

get/v0.1/orders/{id}
Response samples
application/json
{
  • "id": "ETHEREUM:0x334180be75306dab373c4eadc35355f3ce887e4e63d5dc087d7e95a98f83b4d3",
  • "fill": 123456.789,
  • "platform": "RARIBLE",
  • "status": "ACTIVE",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z",
  • "makeStock": 123456.789,
  • "cancelled": true,
  • "optionalRoyalties": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastUpdatedAt": "2019-08-24T14:15:22Z",
  • "dbUpdatedAt": "2019-08-24T14:15:22Z",
  • "makePrice": 123456.789,
  • "takePrice": 123456.789,
  • "makePriceUsd": 123456.789,
  • "takePriceUsd": 123456.789,
  • "maker": "ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a",
  • "taker": "ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a",
  • "make": {
    },
  • "take": {
    },
  • "salt": "string",
  • "signature": "string",
  • "pending": [ ],
  • "data": {
    }
}

getOrdersByIds

Returns the orders that have been put on sale

Request
Request Body schema: application/json
ids
required
Array of strings

Array of the orders Ids in format 'ETHEREUM:${id}'

Responses
200

OK

400

Bad Request

500

Internal Server Error

post/v0.1/orders/byIds
Request samples
application/json
{
  • "ids": [
    ]
}
Response samples
application/json
{
  • "continuation": "string",
  • "orders": [ ]
}

getOrdersAll

Returns all orders

Request
query Parameters
blockchains
Array of strings (Blockchain)

Type of the blockchain network

Items Enum: "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX"
Example: blockchains=ETHEREUM
continuation
string

Continuation token from the previous response

size
integer

The number of items to return

sort
string (OrderSort)

Order sort

Enum: "LAST_UPDATE_ASC" "LAST_UPDATE_DESC"
status
Array of strings (OrderStatus)

Order status

Items Enum: "ACTIVE" "FILLED" "HISTORICAL" "INACTIVE" "CANCELLED"
searchEngine
string (SearchEngine)
Deprecated

Search engine to use for search

Enum: "LEGACY" "V1"
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/orders/all
Response samples
application/json
{
  • "continuation": "string",
  • "orders": [ ]
}

getAllSync

Returns all orders sorting by data base update

Request
query Parameters
blockchain
required
string (Blockchain)

Type of the blockchain network

Enum: "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX"
Example: blockchain=ETHEREUM
continuation
string

Continuation token from the previous response

size
integer

The number of items to return

sort
string (SyncSort)

Order sort

Enum: "DB_UPDATE_ASC" "DB_UPDATE_DESC"
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/orders/sync
Response samples
application/json
{
  • "continuation": "string",
  • "orders": [ ]
}

getSellOrdersByMaker

Returns sell orders by maker

Request
query Parameters
blockchains
Array of strings (Blockchain)
Items Enum: "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX"
Example: blockchains=ETHEREUM
platform
string (Platform)

The platform where the order was created

Enum: "RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
maker
required
Array of strings (UnionAddress)

The maker of the order

Example: maker=ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a
origin
string (UnionAddress)

Address of the consumer to receive the commission for the order

Example: origin=ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a
continuation
string

Continuation token from the previous response

size
integer >= 1

The number of items to return

status
Array of strings (OrderStatus)

Order status

Items Enum: "ACTIVE" "FILLED" "HISTORICAL" "INACTIVE" "CANCELLED"
searchEngine
string (SearchEngine)
Deprecated

Search engine to use for search

Enum: "LEGACY" "V1"
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/orders/sell/byMaker
Response samples
application/json
{
  • "continuation": "string",
  • "orders": [ ]
}

getSellOrdersByItem

Returns sell orders by item

Request
query Parameters
platform
string (Platform)

The platform where the order was created

Enum: "RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
itemId
required
string (ItemId)

Item Id, has format ETHEREUM:${token}:${tokenId}

Example: itemId=ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4:71481372648203575558993015318897331386170125774163974705671968549417949069313
maker
string (UnionAddress)

The maker of the bid

Example: maker=ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a
origin
string (UnionAddress)

Address of the consumer to receive the commission for the order

Example: origin=ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a
status
Array of strings (OrderStatus)

Order status

Items Enum: "ACTIVE" "FILLED" "HISTORICAL" "INACTIVE" "CANCELLED"
continuation
string

Continuation token from the previous response

size
integer >= 1

The number of items to return

searchEngine
string (SearchEngine)
Deprecated

Search engine to use for search

Enum: "LEGACY" "V1"
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/orders/sell/byItem
Response samples
application/json
{
  • "continuation": "string",
  • "orders": [ ]
}

getSellOrders

Returns all sell orders

Request
query Parameters
blockchains
Array of strings (Blockchain)

Names of the blockchain networks. If no one specified, data from all blockchains will be returned

Items Enum: "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX"
Example: blockchains=ETHEREUM
platform
string (Platform)

The platform where the order was created

Enum: "RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
origin
string (UnionAddress)

Address of the consumer to receive the commission for the order

Example: origin=ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a
continuation
string

Continuation token from the previous response

size
integer <int32> >= 1

The number of items to return

searchEngine
string (SearchEngine)
Deprecated

Search engine to use for search

Enum: "LEGACY" "V1"
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/orders/sell
Response samples
application/json
{
  • "continuation": "string",
  • "orders": [ ]
}

getOrderBidsByMaker

Returns order bids by maker

Request
query Parameters
maker
required
Array of strings (UnionAddress)

The maker of the bid

Example: maker=ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a
blockchains
Array of strings (Blockchain)

Names of the blockchain networks. If no one specified, data from all blockchains will be returned

Items Enum: "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX"
Example: blockchains=ETHEREUM
platform
string (Platform)

The platform where the order was created

Enum: "RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
origin
string (UnionAddress)

Address of the consumer to receive the commission for the order

Example: origin=ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a
status
Array of strings (OrderStatus)

Order status

Items Enum: "ACTIVE" "FILLED" "HISTORICAL" "INACTIVE" "CANCELLED"
start
integer <int64>

Lower time border of data (timestamp)

end
integer <int64>

Upper time border of data (timestamp)

continuation
string

Continuation token from the previous response

size
integer <int32> >= 1

The number of items to return

searchEngine
string (SearchEngine)
Deprecated

Search engine to use for search

Enum: "LEGACY" "V1"
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/orders/bids/byMaker
Response samples
application/json
{
  • "continuation": "string",
  • "orders": [ ]
}

getOrderBidsByItem

Returns order bids by item

Request
query Parameters
platform
string (Platform)

The platform where the order was created

Enum: "RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
itemId
required
string (ItemId)

Item Id, has format ETHEREUM:${token}:${tokenId}

Example: itemId=ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4:71481372648203575558993015318897331386170125774163974705671968549417949069313
maker
Array of strings (UnionAddress)

The maker of the bid

Example: maker=ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a
origin
string (UnionAddress)

Address of the consumer to receive the commission for the order

Example: origin=ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a
status
Array of strings (OrderStatus)

Order status

Items Enum: "ACTIVE" "FILLED" "HISTORICAL" "INACTIVE" "CANCELLED"
start
integer <int64>

Lower time border of data (timestamp)

end
integer <int64>

Upper time border of data (timestamp)

continuation
string

Continuation token from the previous response

size
integer

The number of items to return

searchEngine
string (SearchEngine)
Deprecated

Search engine to use for search

Enum: "LEGACY" "V1"
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/orders/bids/byItem
Response samples
application/json
{
  • "continuation": "string",
  • "orders": [ ]
}