--- updatedAt: 2025-11-06T17:36:08.000Z agentTools: projectIndex: https://reservoirprotocol.readme.io/llms.txt --- # Submit Signed Orders > 🚧 We recommend using Reservoir SDK > > [Reservoir SDK](https://reservoirprotocol.readme.io/reference/reservoir-sdk-jstsnode) includes helpers that abstract the process of using the Trading API such as iterating through execution steps and returning callbacks that can be used to update your UI. If you are developing in TS/JS we recommend using the ReservoirSDK. # OpenAPI definition ```json { "openapi": "3.0.0", "security": [ { "API_KEY": [] } ], "info": { "title": "Reservoir API", "version": "5.296.1", "description": "You are viewing the reference docs for the Reservoir API. For a more complete overview with guides and examples, check out the Reservoir Protocol Docs." }, "paths": { "/order/v4": { "post": { "summary": "Submit Signed Orders", "operationId": "postOrderV4", "parameters": [ { "x-convert": { "case": "lower" }, "name": "signature", "in": "query", "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]*$" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Model512" } } } }, "tags": [ "Manage Orders" ], "responses": { "200": { "description": "Successful", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/postOrderV4Response" } } } } }, "x-order": 5 } } }, "x-alt-definitions": { "data": { "type": "object", "properties": { "collectionId": { "type": "string" }, "collectionName": { "type": "string" }, "tokenName": { "type": "string" }, "image": { "type": "string" } } }, "metadata": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "token" ] }, "data": { "$ref": "#/x-alt-definitions/data" } } }, "Model1": { "type": "object", "properties": { "collectionId": { "type": "string" }, "collectionName": { "type": "string" }, "image": { "type": "string" } } }, "Model2": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "collection" ] }, "data": { "$ref": "#/x-alt-definitions/Model1" } } }, "Model3": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "value" ] }, "attributes": { "type": "array", "items": { "$ref": "#/x-alt-definitions/Model3" } }, "Model4": { "type": "object", "properties": { "collectionId": { "type": "string" }, "collectionName": { "type": "string" }, "attributes": { "$ref": "#/x-alt-definitions/attributes" }, "image": { "type": "string" } } }, "Model5": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "attribute" ] }, "data": { "$ref": "#/x-alt-definitions/Model4" } } }, "token": { "type": "object", "properties": { "tokenId": { "type": "string", "pattern": "^-?[0-9]+$" }, "name": { "type": "string" }, "image": { "type": "string" }, "isSpam": { "type": "boolean" }, "isNsfw": { "type": "boolean" } } }, "collection": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "image": { "type": "string" }, "isSpam": { "type": "boolean" }, "isNsfw": { "type": "boolean" } } }, "Model6": { "type": "object", "properties": { "token": { "$ref": "#/x-alt-definitions/token" }, "collection": { "$ref": "#/x-alt-definitions/collection" } } }, "criteria": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "token" ] }, "data": { "$ref": "#/x-alt-definitions/Model6" } } }, "Model7": { "type": "object", "properties": { "collection": { "$ref": "#/x-alt-definitions/collection" } } }, "Model8": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "collection" ] }, "data": { "$ref": "#/x-alt-definitions/Model7" } } }, "Model9": { "type": "object", "properties": { "collection": { "$ref": "#/x-alt-definitions/collection" }, "attribute": { "$ref": "#/x-alt-definitions/Model3" } } }, "Model10": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "attribute" ] }, "data": { "$ref": "#/x-alt-definitions/Model9" } } }, "Model11": { "type": "object", "properties": { "tokenSetId": { "type": "string" } } }, "Model12": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "custom" ] }, "data": { "$ref": "#/x-alt-definitions/Model11" } } }, "Model13": { "type": "object", "properties": { "collectionName": { "type": "string" }, "tokenName": { "type": "string" }, "image": { "type": "string" } } }, "Model14": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "token" ] }, "data": { "$ref": "#/x-alt-definitions/Model13" } } }, "Model15": { "type": "object", "properties": { "collectionName": { "type": "string" }, "image": { "type": "string" } } }, "Model16": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "collection" ] }, "data": { "$ref": "#/x-alt-definitions/Model15" } } }, "Model17": { "type": "object", "properties": { "collectionName": { "type": "string" }, "attributes": { "$ref": "#/x-alt-definitions/attributes" }, "image": { "type": "string" } } }, "Model18": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "attribute" ] }, "data": { "$ref": "#/x-alt-definitions/Model17" } } }, "currency": { "type": "object", "properties": { "contract": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "decimals": { "type": "number" }, "chainId": { "type": "number" } } }, "amount": { "type": "object", "description": "Amount with fees & royalties included.", "properties": { "raw": { "type": "string", "pattern": "^-?[0-9]+$" }, "decimal": { "type": "number" }, "usd": { "type": "number" }, "native": { "type": "number" } } }, "netAmount": { "type": "object", "description": "Amount with fees & royalties removed.", "properties": { "raw": { "type": "string", "pattern": "^-?[0-9]+$" }, "decimal": { "type": "number" }, "usd": { "type": "number" }, "native": { "type": "number" } } }, "start": { "type": "object", "properties": { "currency": { "$ref": "#/x-alt-definitions/currency" }, "amount": { "$ref": "#/x-alt-definitions/amount" }, "netAmount": { "$ref": "#/x-alt-definitions/netAmount" } } }, "price": { "type": "object", "properties": { "start": { "$ref": "#/x-alt-definitions/start" }, "end": { "$ref": "#/x-alt-definitions/start" } } }, "time": { "type": "object", "properties": { "start": { "type": "number" }, "end": { "type": "number" } } }, "Model19": { "type": "object", "properties": { "price": { "$ref": "#/x-alt-definitions/price" }, "time": { "$ref": "#/x-alt-definitions/time" } } }, "dynamicPricing": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "dutch" ] }, "data": { "$ref": "#/x-alt-definitions/Model19" } } }, "prices": { "type": "array", "items": { "$ref": "#/x-alt-definitions/start" } }, "Model20": { "type": "object", "properties": { "pool": { "type": "string" }, "prices": { "$ref": "#/x-alt-definitions/prices" } } }, "Model21": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "pool" ] }, "data": { "$ref": "#/x-alt-definitions/Model20" } } }, "Model22": { "type": "object", "properties": { "fromBlock": { "type": "number" }, "toBlock": { "type": "number" }, "blockRange": { "type": "number" } }, "required": [ "fromBlock", "toBlock" ] }, "Model23": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "all" ] }, "data": { "$ref": "#/x-alt-definitions/Model22" } } }, "Model24": { "type": "object", "properties": { "contract": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "fromTimestamp": { "type": "number" }, "toTimestamp": { "type": "number" }, "timestampRange": { "type": "number" } }, "required": [ "contract", "fromTimestamp", "toTimestamp" ] }, "Model25": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "contract" ] }, "data": { "$ref": "#/x-alt-definitions/Model24" } } }, "Model26": { "type": "object", "properties": { "txHash": { "type": "string", "pattern": "^0x[a-fA-F0-9]{64}$" } }, "required": [ "txHash" ] }, "Model27": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transaction" ] }, "data": { "$ref": "#/x-alt-definitions/Model26" } } }, "events": { "type": "array", "items": { "type": "string" } }, "eventsType": { "type": "array", "items": { "type": "string", "enum": [ "ftTransferEvents" ] } }, "syncDetails": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "events" ] }, "events": { "$ref": "#/x-alt-definitions/events" }, "eventsType": { "$ref": "#/x-alt-definitions/eventsType" } } }, "Model28": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "address" ] }, "address": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" } } }, "collections": { "type": "array", "description": "Array of collection ids to disable metadata for. Max limit is 50. Example: `collections[0]: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63 collections[1]: 0x521f9c7505005cfa19a8e5786a9c3c9c9f5e6f42`", "maxItems": 50, "items": { "type": "string", "x-convert": { "case": "lower" } } }, "Model29": { "type": "array", "description": "Update to one or more collections. Max limit is 50. Example: `0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63`", "minItems": 1, "maxItems": 50, "items": { "type": "string", "x-convert": { "case": "lower" } } }, "exactOrderSource": { "type": "array", "maxItems": 2, "items": { "type": "string", "pattern": "^[a-zA-Z0-9.-]+\\.[a-zA-Z0-9]{2,}$|localhost", "x-convert": { "case": "lower" } } }, "ids": { "type": "array", "description": "Array of order ids to invalidate. Max limit is 50. Example: `ids[0]: 0x505b35e849bccbd787bf670b3e85577fa5c2814cfa0ecab50867e4dc5b5362d4 ids[1]: 0xd0e83bdeb5b79352d4a3657387d1e438e9df68d773bb3b3c88da41948ef48188`", "maxItems": 50, "items": { "type": "string" } }, "tokens": { "type": "array", "description": "Array of tokens to disable or reenable metadata for. Max limit is 50. Example: `tokens[0]: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63:704 tokens[1]: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63:979`", "maxItems": 50, "items": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}:[0-9]+$", "x-convert": { "case": "lower" } } }, "Model30": { "type": "array", "description": "Array of tokens. Max limit is 50. Example: `tokens[0]: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63:704 tokens[1]: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63:979`", "maxItems": 50, "items": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}:[0-9]+$", "x-convert": { "case": "lower" } } }, "Model31": { "type": "array", "description": "Array of tokens to refresh. Max limit is 50. Example: `tokens[0]: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63:704 tokens[1]: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63:979`", "maxItems": 50, "items": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}:[0-9]+$", "x-convert": { "case": "lower" } } } }, "servers": [ { "url": "https://api.reservoir.tools", "description": "Ethereum" }, { "url": "https://api-polygon.reservoir.tools", "description": "Polygon" }, { "url": "https://api-base.reservoir.tools", "description": "Base" }, { "url": "https://api-abstract.reservoir.tools", "description": "Abstract" }, { "url": "https://api-abstract-testnet.reservoir.tools", "description": "Abstract Testnet" }, { "url": "https://api-ancient8.reservoir.tools", "description": "Ancient8" }, { "url": "https://api-ancient8-testnet.reservoir.tools", "description": "Ancient8 Testnet" }, { "url": "https://api-anime-testnet.reservoir.tools", "description": "Anime Testnet" }, { "url": "https://api-apechain.reservoir.tools", "description": "Apechain" }, { "url": "https://api-apex.reservoir.tools", "description": "Apex" }, { "url": "https://api-apex-testnet.reservoir.tools", "description": "Apex Testnet" }, { "url": "https://api-arbitrum.reservoir.tools", "description": "Arbitrum" }, { "url": "https://api-arbitrum-nova.reservoir.tools", "description": "Arbitrum Nova" }, { "url": "https://api-astar-zkevm.reservoir.tools", "description": "Astar zkEVM" }, { "url": "https://api-avalanche.reservoir.tools", "description": "Avalanche" }, { "url": "https://api-amoy.reservoir.tools", "description": "Amoy" }, { "url": "https://api-base-sepolia.reservoir.tools", "description": "Base Sepolia" }, { "url": "https://api-berachain.reservoir.tools", "description": "Berachain" }, { "url": "https://api-berachain-testnet.reservoir.tools", "description": "Berachain Testnet" }, { "url": "https://api-b3.reservoir.tools", "description": "B3" }, { "url": "https://api-b3-testnet.reservoir.tools", "description": "B3 Testnet" }, { "url": "https://api-bitlayer.reservoir.tools", "description": "Bitlayer" }, { "url": "https://api-blast.reservoir.tools", "description": "Blast" }, { "url": "https://api-blast-sepolia.reservoir.tools", "description": "Blast Sepolia" }, { "url": "https://api-boss.reservoir.tools", "description": "Boss" }, { "url": "https://api-bsc.reservoir.tools", "description": "Binance Smart Chain" }, { "url": "https://api-cloud.reservoir.tools", "description": "Cloud" }, { "url": "https://api-creator-testnet.reservoir.tools", "description": "Creator Testnet" }, { "url": "https://api-curtis.reservoir.tools", "description": "Curtis" }, { "url": "https://api-cyber.reservoir.tools", "description": "Cyber" }, { "url": "https://api-degen.reservoir.tools", "description": "Degen" }, { "url": "https://api-flow.reservoir.tools", "description": "Flow" }, { "url": "https://api-forma.reservoir.tools", "description": "Forma" }, { "url": "https://api-forma-sketchpad.reservoir.tools", "description": "Forma Sketchpad" }, { "url": "https://api-frame-testnet.reservoir.tools", "description": "Frame Testnet" }, { "url": "https://api-game7.reservoir.tools", "description": "Game7" }, { "url": "https://api-game7-testnet.reservoir.tools", "description": "Game7 Testnet" }, { "url": "https://api-hychain.reservoir.tools", "description": "Hychain" }, { "url": "https://api-hychain-testnet.reservoir.tools", "description": "Hychain Testnet" }, { "url": "https://api-ink.reservoir.tools", "description": "Ink" }, { "url": "https://api-linea.reservoir.tools", "description": "Linea" }, { "url": "https://api-minato.reservoir.tools", "description": "Minato" }, { "url": "https://api-monad-testnet.reservoir.tools", "description": "Monad Testnet" }, { "url": "https://api-nebula.reservoir.tools", "description": "Nebula" }, { "url": "https://api-opbnb.reservoir.tools", "description": "OPBNB" }, { "url": "https://api-optimism.reservoir.tools", "description": "Optimism" }, { "url": "https://api-polygon-zkevm.reservoir.tools", "description": "Polygon zkEVM" }, { "url": "https://api-redstone.reservoir.tools", "description": "Redstone" }, { "url": "https://api-scroll.reservoir.tools", "description": "Scroll" }, { "url": "https://api-sei.reservoir.tools", "description": "Sei" }, { "url": "https://api-sei-testnet.reservoir.tools", "description": "Sei Testnet" }, { "url": "https://api-sepolia.reservoir.tools", "description": "Sepolia" }, { "url": "https://api-shape.reservoir.tools", "description": "Shape" }, { "url": "https://api-shape-sepolia.reservoir.tools", "description": "Shape Sepolia" }, { "url": "https://api-soneium.reservoir.tools", "description": "Soneium" }, { "url": "https://api-story-odyssey.reservoir.tools", "description": "Story Odyssey" }, { "url": "https://api-xai.reservoir.tools", "description": "Xai" }, { "url": "https://api-zero.reservoir.tools", "description": "Zero" }, { "url": "https://api-zero-testnet.reservoir.tools", "description": "Zero Testnet" }, { "url": "https://api-zksync.reservoir.tools", "description": "zkSync" }, { "url": "https://api-zora.reservoir.tools", "description": "Zora" } ], "components": { "securitySchemes": { "API_KEY": { "type": "apiKey", "name": "x-api-key", "in": "header", "x-default": "demo-api-key" } }, "schemas": { "metadata": { "type": "object" }, "sampleImages": { "type": "array", "items": { "type": "string" } }, "attribute": { "type": "object", "properties": { "collection": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "collection", "key", "value" ] }, "Model508": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "blur", "opensea", "looks-rare-v2", "zeroex-v4", "seaport", "seaport-v1.4", "seaport-v1.5", "seaport-v1.6", "mintify", "x2y2", "alienswap", "payment-processor", "payment-processor-v2", "payment-processor-v2.1" ], "x-convert": { "case": "lower" } }, "data": { "$ref": "#/components/schemas/metadata" } }, "required": [ "kind", "data" ] }, "Model509": { "type": "object", "properties": { "orderIndex": { "type": "number" }, "merkleProof": { "$ref": "#/components/schemas/sampleImages" } }, "required": [ "orderIndex", "merkleProof" ] }, "bulkData": { "type": "object", "properties": { "kind": { "type": "string", "default": "seaport-v1.5", "enum": [ "seaport-v1.4", "seaport-v1.5", "seaport-v1.6", "alienswap", "mintify", "payment-processor-v2.1" ] }, "data": { "$ref": "#/components/schemas/Model509" } } }, "Model510": { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/Model508" }, "orderbook": { "type": "string", "default": "reservoir", "enum": [ "blur", "reservoir", "opensea", "looks-rare", "x2y2" ], "x-convert": { "case": "lower" } }, "orderbookApiKey": { "type": "string", "description": "Optional API key for the target orderbook" }, "attribute": { "$ref": "#/components/schemas/attribute" }, "collection": { "type": "string" }, "tokenSetId": { "type": "string" }, "isNonFlagged": { "type": "boolean" }, "permitId": { "type": "string" }, "permitIndex": { "type": "number" }, "bulkData": { "$ref": "#/components/schemas/bulkData" } } }, "Model511": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Model510" } }, "Model512": { "type": "object", "properties": { "items": { "$ref": "#/components/schemas/Model511" }, "source": { "type": "string", "description": "The source domain", "pattern": "^[a-zA-Z0-9.-]+\\.[a-zA-Z0-9]{2,}$|localhost" } } }, "Model513": { "type": "object", "properties": { "message": { "type": "string" }, "orderId": { "type": "string" }, "orderIndex": { "type": "number" }, "crossPostingOrderId": { "type": "string", "description": "Only available when posting to external orderbook. Can be used to retrieve the status of a cross-post order." }, "crossPostingOrderStatus": { "type": "string", "description": "Current cross-post order status. Responses are `pending`, `posted`, or `failed`." } } }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Model513" } }, "postOrderV4Response": { "type": "object", "properties": { "results": { "$ref": "#/components/schemas/results" } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```