marketplace

CheckoutOptionsMarketplace

SecurityApiKeyAuth

Request

Request Body schema: application/json

additionalFee	number
	Array of objects (CheckoutOptionsMarketplaceOrder) []CheckoutOptionsMarketplaceOrder
wallet	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/CheckoutOptionsMarketplace

Request samples

Payload
curl

application/json

{"additionalFee": 0,
"orders": [{"contractAddress": "string",
"marketplace": "unknown",
"orderId": "string"
}
],
"wallet": "string"
}

Response samples

application/json

{"options": {"crypto": "none",
"nftCheckout": ["unknown"
],
"onRamp": ["unknown"
],
"swap": ["unknown"
]
}
}

CheckoutOptionsSalesContract

SecurityApiKeyAuth

Request

Request Body schema: application/json

collectionAddress	string
contractAddress	string
	Array of objects (CheckoutOptionsItem) []CheckoutOptionsItem
wallet	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/CheckoutOptionsSalesContract

Request samples

Payload
curl

application/json

{"collectionAddress": "string",
"contractAddress": "string",
"items": [{"quantity": "string",
"tokenId": "string"
}
],
"wallet": "string"
}

Response samples

application/json

{"options": {"crypto": "none",
"nftCheckout": ["unknown"
],
"onRamp": ["unknown"
],
"swap": ["unknown"
]
}
}

Execute

only used in a case of external transactions ( when we create off-chain transactions ) for instance opensea market

SecurityApiKeyAuth

Request

Request Body schema: application/json

body	object
executeType	string (ExecuteType) Represented as uint32 on the server side Enum: "unknown" "order"
signature	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/Execute

Request samples

Payload
curl

application/json

{"body": { },
"executeType": "unknown",
"signature": "string"
}

Response samples

application/json

{"orderId": "string"
}

GenerateBuyTransaction

checkout process

SecurityApiKeyAuth

Request

Request Body schema: application/json

	Array of objects (AdditionalFee) []AdditionalFee
buyer	string
collectionAddress	string
marketplace	string (MarketplaceKind) Represented as uint32 on the server side Enum: "unknown" "sequence_marketplace_v1" "sequence_marketplace_v2" "opensea" "magic_eden" "mintify" "looks_rare" "x2y2" "sudo_swap" "coinbase" "rarible" "nftx" "foundation" "manifold" "zora" "blur" "super_rare" "okx" "element" "aqua_xyz" "auranft_co"
	Array of objects (OrderData) []OrderData
walletType	string (WalletKind) Represented as uint8 on the server side Enum: "unknown" "sequence"

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GenerateBuyTransaction

Request samples

Payload
curl

application/json

{"additionalFees": [{"amount": "string",
"receiver": "string"
}
],
"buyer": "string",
"collectionAddress": "string",
"marketplace": "unknown",
"ordersData": [{"orderId": "string",
"quantity": "string"
}
],
"walletType": "unknown"
}

Response samples

application/json

{"steps": [{"data": "string",
"executeType": "unknown",
"id": "unknown",
"post": {"body": { },
"endpoint": "string",
"method": "string"
},
"signature": {"domain": {"chainId": 0,
"name": "string",
"verifyingContract": "string",
"version": "string"
},
"primaryType": "string",
"types": { },
"value": { }
},
"to": "string",
"value": "string"
}
]
}

GenerateListingTransaction

SecurityApiKeyAuth

Request

Request Body schema: application/json

collectionAddress	string
contractType	string (ContractType) Represented as uint16 on the server side Enum: "UNKNOWN" "ERC20" "ERC721" "ERC1155"
	object (CreateReq)
orderbook	string (OrderbookKind) Represented as uint32 on the server side Enum: "unknown" "sequence_marketplace_v1" "sequence_marketplace_v2" "blur" "opensea" "looks_rare" "reservoir" "x2y2"
owner	string
walletType	string (WalletKind) Represented as uint8 on the server side Enum: "unknown" "sequence"

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GenerateListingTransaction

Request samples

Payload
curl

application/json

{"collectionAddress": "string",
"contractType": "UNKNOWN",
"listing": {"currencyAddress": "string",
"expiry": "string",
"pricePerToken": "string",
"quantity": "string",
"tokenId": "string"
},
"orderbook": "unknown",
"owner": "string",
"walletType": "unknown"
}

Response samples

application/json

{"steps": [{"data": "string",
"executeType": "unknown",
"id": "unknown",
"post": {"body": { },
"endpoint": "string",
"method": "string"
},
"signature": {"domain": {"chainId": 0,
"name": "string",
"verifyingContract": "string",
"version": "string"
},
"primaryType": "string",
"types": { },
"value": { }
},
"to": "string",
"value": "string"
}
]
}

GenerateOfferTransaction

SecurityApiKeyAuth

Request

Request Body schema: application/json

collectionAddress	string
contractType	string (ContractType) Represented as uint16 on the server side Enum: "UNKNOWN" "ERC20" "ERC721" "ERC1155"
maker	string
	object (CreateReq)
orderbook	string (OrderbookKind) Represented as uint32 on the server side Enum: "unknown" "sequence_marketplace_v1" "sequence_marketplace_v2" "blur" "opensea" "looks_rare" "reservoir" "x2y2"
walletType	string (WalletKind) Represented as uint8 on the server side Enum: "unknown" "sequence"

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GenerateOfferTransaction

Request samples

Payload
curl

application/json

{"collectionAddress": "string",
"contractType": "UNKNOWN",
"maker": "string",
"offer": {"currencyAddress": "string",
"expiry": "string",
"pricePerToken": "string",
"quantity": "string",
"tokenId": "string"
},
"orderbook": "unknown",
"walletType": "unknown"
}

Response samples

application/json

{"steps": [{"data": "string",
"executeType": "unknown",
"id": "unknown",
"post": {"body": { },
"endpoint": "string",
"method": "string"
},
"signature": {"domain": {"chainId": 0,
"name": "string",
"verifyingContract": "string",
"version": "string"
},
"primaryType": "string",
"types": { },
"value": { }
},
"to": "string",
"value": "string"
}
]
}

GenerateSellTransaction

SecurityApiKeyAuth

Request

Request Body schema: application/json

	Array of objects (AdditionalFee) []AdditionalFee
buyer	string
collectionAddress	string
marketplace	string (MarketplaceKind) Represented as uint32 on the server side Enum: "unknown" "sequence_marketplace_v1" "sequence_marketplace_v2" "opensea" "magic_eden" "mintify" "looks_rare" "x2y2" "sudo_swap" "coinbase" "rarible" "nftx" "foundation" "manifold" "zora" "blur" "super_rare" "okx" "element" "aqua_xyz" "auranft_co"
	Array of objects (OrderData) []OrderData
walletType	string (WalletKind) Represented as uint8 on the server side Enum: "unknown" "sequence"

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GenerateSellTransaction

Request samples

Payload
curl

application/json

{"additionalFees": [{"amount": "string",
"receiver": "string"
}
],
"buyer": "string",
"collectionAddress": "string",
"marketplace": "unknown",
"ordersData": [{"orderId": "string",
"quantity": "string"
}
],
"walletType": "unknown"
}

Response samples

application/json

{"steps": [{"data": "string",
"executeType": "unknown",
"id": "unknown",
"post": {"body": { },
"endpoint": "string",
"method": "string"
},
"signature": {"domain": {"chainId": 0,
"name": "string",
"verifyingContract": "string",
"version": "string"
},
"primaryType": "string",
"types": { },
"value": { }
},
"to": "string",
"value": "string"
}
]
}

GetCollectible

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GetCollectible

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"tokenId": "string"
}

Response samples

application/json

{"metadata": {"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
}
}

GetCollectibleHighestListing

This endpoint is deprecated. Please use GetHighestPriceListingForCollectible()

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (OrderFilter)
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GetCollectibleHighestListing

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"createdBy": ["string"
],
"currencies": ["string"
],
"marketplace": ["unknown"
]
},
"tokenId": "string"
}

Response samples

application/json

{"order": {"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
}

GetCollectibleHighestOffer

This endpoint is deprecated. Please use GetHighestPriceOfferForCollectible()

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (OrderFilter)
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GetCollectibleHighestOffer

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"createdBy": ["string"
],
"currencies": ["string"
],
"marketplace": ["unknown"
]
},
"tokenId": "string"
}

Response samples

application/json

{"order": {"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
}

GetCollectibleLowestListing

This endpoint is deprecated. Please use GetLowestPriceListingForCollectible()

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (OrderFilter)
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GetCollectibleLowestListing

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"createdBy": ["string"
],
"currencies": ["string"
],
"marketplace": ["unknown"
]
},
"tokenId": "string"
}

Response samples

application/json

{"order": {"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
}

GetCollectibleLowestOffer

This endpoint is deprecated. Please use the GetLowestPriceOfferForCollectible

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (OrderFilter)
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GetCollectibleLowestOffer

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"createdBy": ["string"
],
"currencies": ["string"
],
"marketplace": ["unknown"
]
},
"tokenId": "string"
}

Response samples

application/json

{"order": {"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
}

GetFloorOrder

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (CollectiblesFilter)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GetFloorOrder

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"inAccounts": ["string"
],
"includeEmpty": true,
"marketplaces": ["unknown"
],
"notInAccounts": ["string"
],
"ordersCreatedBy": ["string"
],
"ordersNotCreatedBy": ["string"
],
"properties": [{"max": 0,
"min": 0,
"name": "string",
"type": "INT",
"values": [{ }
]
}
],
"searchText": "string"
}
}

Response samples

application/json

{"collectible": {"metadata": {"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
},
"order": {"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
}
}

GetHighestPriceListingForCollectible

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (OrderFilter)
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GetHighestPriceListingForCollectible

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"createdBy": ["string"
],
"currencies": ["string"
],
"marketplace": ["unknown"
]
},
"tokenId": "string"
}

Response samples

application/json

{"order": {"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
}

GetHighestPriceOfferForCollectible

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (OrderFilter)
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GetHighestPriceOfferForCollectible

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"createdBy": ["string"
],
"currencies": ["string"
],
"marketplace": ["unknown"
]
},
"tokenId": "string"
}

Response samples

application/json

{"order": {"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
}

GetLowestPriceListingForCollectible

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (OrderFilter)
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GetLowestPriceListingForCollectible

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"createdBy": ["string"
],
"currencies": ["string"
],
"marketplace": ["unknown"
]
},
"tokenId": "string"
}

Response samples

application/json

{"order": {"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
}

GetLowestPriceOfferForCollectible

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (OrderFilter)
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GetLowestPriceOfferForCollectible

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"createdBy": ["string"
],
"currencies": ["string"
],
"marketplace": ["unknown"
]
},
"tokenId": "string"
}

Response samples

application/json

{"order": {"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
}

GetOrders

SecurityApiKeyAuth

Request

Request Body schema: application/json

	Array of objects (GetOrdersInput) []GetOrdersInput
	object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/GetOrders

Request samples

Payload
curl

application/json

{"input": [{"contractAddress": "string",
"marketplace": "unknown",
"orderId": "string"
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

Response samples

application/json

{"orders": [{"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

ListCollectibleListings

This endpoint is deprecated. Please use ListListingsForCollectible()

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (OrderFilter)
	object (Page)
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/ListCollectibleListings

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"createdBy": ["string"
],
"currencies": ["string"
],
"marketplace": ["unknown"
]
},
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"tokenId": "string"
}

Response samples

application/json

{"listings": [{"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

ListCollectibleOffers

This endpoint is deprecated. Please use ListOffersForCollectible()

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (OrderFilter)
	object (Page)
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/ListCollectibleOffers

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"createdBy": ["string"
],
"currencies": ["string"
],
"marketplace": ["unknown"
]
},
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"tokenId": "string"
}

Response samples

application/json

{"offers": [{"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

ListCollectibles

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (CollectiblesFilter)
	object (Page)
side	string (OrderSide) Represented as uint8 on the server side Enum: "unknown" "listing" "offer"

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/ListCollectibles

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"inAccounts": ["string"
],
"includeEmpty": true,
"marketplaces": ["unknown"
],
"notInAccounts": ["string"
],
"ordersCreatedBy": ["string"
],
"ordersNotCreatedBy": ["string"
],
"properties": [{"max": 0,
"min": 0,
"name": "string",
"type": "INT",
"values": [{ }
]
}
],
"searchText": "string"
},
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"side": "unknown"
}

Response samples

application/json

{"collectibles": [{"metadata": {"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
},
"order": {"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

ListCollectiblesWithHighestOffer

Deprecated use ListCollectibles() with OrderSide = Offer

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (CollectiblesFilter)
	object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/ListCollectiblesWithHighestOffer

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"inAccounts": ["string"
],
"includeEmpty": true,
"marketplaces": ["unknown"
],
"notInAccounts": ["string"
],
"ordersCreatedBy": ["string"
],
"ordersNotCreatedBy": ["string"
],
"properties": [{"max": 0,
"min": 0,
"name": "string",
"type": "INT",
"values": [{ }
]
}
],
"searchText": "string"
},
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

Response samples

application/json

{"collectibles": [{"metadata": {"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
},
"order": {"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

ListCollectiblesWithLowestListing

Deprecated use ListCollectibles() with OrderSide = Listing

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (CollectiblesFilter)
	object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/ListCollectiblesWithLowestListing

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"inAccounts": ["string"
],
"includeEmpty": true,
"marketplaces": ["unknown"
],
"notInAccounts": ["string"
],
"ordersCreatedBy": ["string"
],
"ordersNotCreatedBy": ["string"
],
"properties": [{"max": 0,
"min": 0,
"name": "string",
"type": "INT",
"values": [{ }
]
}
],
"searchText": "string"
},
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

Response samples

application/json

{"collectibles": [{"metadata": {"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
},
"order": {"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

ListCurrencies

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (Marketplace_ListCurrencies_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/ListCurrencies

Request samples

Payload
curl

application/json

{ }

Response samples

application/json

{"currencies": [{"chainId": 0,
"contractAddress": "string",
"createdAt": "string",
"decimals": 0,
"defaultChainCurrency": true,
"deletedAt": "string",
"exchangeRate": 0,
"id": 0,
"imageUrl": "string",
"name": "string",
"nativeCurrency": true,
"sardineSupported": true,
"symbol": "string",
"transakSupported": true,
"updatedAt": "string"
}
]
}

ListListingsForCollectible

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (OrderFilter)
	object (Page)
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/ListListingsForCollectible

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"createdBy": ["string"
],
"currencies": ["string"
],
"marketplace": ["unknown"
]
},
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"tokenId": "string"
}

Response samples

application/json

{"listings": [{"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

ListOffersForCollectible

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
	object (OrderFilter)
	object (Page)
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Marketplace/ListOffersForCollectible

Request samples

Payload
curl

application/json

{"contractAddress": "string",
"filter": {"createdBy": ["string"
],
"currencies": ["string"
],
"marketplace": ["unknown"
]
},
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"tokenId": "string"
}

Response samples

application/json

{"offers": [{"chainId": 0,
"collectibleId": 0,
"collectionContractAddress": "string",
"collectionId": 0,
"createdAt": "string",
"createdBy": "string",
"deletedAt": "string",
"feeBps": 0,
"feeBreakdown": [{"bps": 0,
"kind": "string",
"recipientAddress": "string"
}
],
"id": 0,
"marketplace": "unknown",
"orderCreatedAt": "string",
"orderId": "string",
"orderUpdatedAt": "string",
"priceAmount": "string",
"priceAmountFormatted": "string",
"priceAmountNet": "string",
"priceAmountNetFormatted": "string",
"priceCurrencyAddress": "string",
"priceDecimals": 0,
"priceUSD": 0,
"quantityAvailable": "string",
"quantityAvailableFormatted": "string",
"quantityDecimals": 0,
"quantityInitial": "string",
"quantityInitialFormatted": "string",
"quantityRemaining": "string",
"quantityRemainingFormatted": "string",
"side": "unknown",
"source": "unknown",
"status": "unknown",
"tokenId": "string",
"updatedAt": "string",
"validFrom": "string",
"validUntil": "string"
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

➔ Next to relayer