Buy fees should only include maker marketplace fees and should be no more than two entries as more entires will incur more gas. It is best practice to have this as few as possible.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Documentation","colors":{"primary":"#F5B941","light":"#FFD876","dark":"#D4982F"},"logo":{"light":"https://mintcdn.com/immutable-b818fae7/aPl7c1S4nykO3QqA/logo/light.svg?fit=max\u0026auto=format\u0026n=aPl7c1S4nykO3QqA\u0026q=85\u0026s=6acd3ff9f0fe8cceb4285c3e8817ebd7","dark":"https://mintcdn.com/immutable-b818fae7/aPl7c1S4nykO3QqA/logo/dark.svg?fit=max\u0026auto=format\u0026n=aPl7c1S4nykO3QqA\u0026q=85\u0026s=ae0b1af018107c996b798aa6b30b768e"},"favicon":{"light":"https://mintcdn.com/immutable-b818fae7/aPl7c1S4nykO3QqA/favicon-light.svg?fit=max\u0026auto=format\u0026n=aPl7c1S4nykO3QqA\u0026q=85\u0026s=aaf05ff4a65b1f6e2a2e5ef187eaa4b2","dark":"https://mintcdn.com/immutable-b818fae7/aPl7c1S4nykO3QqA/favicon-dark.svg?fit=max\u0026auto=format\u0026n=aPl7c1S4nykO3QqA\u0026q=85\u0026s=71ef85013d4eb6b3c18b7a3ca4cc070e"},"api":{"playground":{}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"https://play.immutable.com","label":"Player Support"},{"href":"https://status.immutable.com","label":"Status"}],"primary":{"type":"button","label":"Hub","href":"https://hub.immutable.com"}},"footer":{"socials":{"x":"https://x.com/immutable","github":"https://github.com/immutable","linkedin":"https://linkedin.com/company/immutable"}},"seo":{},"contextual":{"options":["chatgpt","claude","mcp","cursor","vscode","copy"],"display":"header"},"metadata":{"timestamp":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"immutable-b818fae7","hasAudioNarration":false,"actualSubdomain":"immutable-b818fae7","customDomains":["docs.immutable.com"],"gitSource":{"type":"github","owner":"immutable","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ab5e02cca86fa752fb31bd0","collectionId":"7218597d-a772-4e88-8a91-b252239828d6","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ab5e02cca86fa752fb31bd0"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ab5e02cca86fa752fb31bd0","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Docs","count":76},{"language":"default","tag":"PRODUCTS","count":70},{"language":"default","tag":"API Reference","count":63},{"language":"default","tag":"Blockchain","count":59},{"language":"default","tag":"Chain","count":39},{"language":"default","tag":"orders","count":19},{"language":"default","tag":"Attribution","count":16},{"language":"default","tag":"Asset Contracts","count":10},{"language":"default","tag":"Orderbook","count":10},{"language":"default","tag":"Checkout","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--solar-gold:#F5B941;--solar-gold-light:#FFD876;--solar-gold-dark:#D4982F}img[src*=\"/icons/\"]{filter:brightness(0) saturate(100%) invert(1)}:root:not(.dark) img[src*=\"/icons/\"]{filter:brightness(0) saturate(100%)}"}],"page":{"pagePath":"api-reference/orders/create-a-collection-bid","slug":"/api-reference/orders/create-a-collection-bid","pageMetadata":{"title":"Create a collection bid","description":"Create a collection bid","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/chains/{chain_name}/orders/collection-bids","href":"/api-reference/orders/create-a-collection-bid","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a collection bid\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a collection bid","description":"Create a collection bid","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/chains/{chain_name}/orders/collection-bids","href":"/api-reference/orders/create-a-collection-bid","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["orders"],"summary":"Create a collection bid","description":"Create a collection bid","operationId":"CreateCollectionBid","x-public":true,"parameters":["d870401d-c5ca-40fe-ad03-9533a0d1775c"],"requestBody":"cb3fa11a-9ad5-482b-bd00-e6b6e002f2e6","responses":{"201":"a1eeff4a-be21-4db7-a20e-b2e5d988b62e","400":"29665e6f-43cb-44fd-867f-80a23465c8d5","404":"576b2a92-389f-40b1-b0e1-81b913817710","500":"6a0e34ff-10f2-45a3-ad09-7724d202994e","501":"8d73a228-6b01-4599-a0ed-82e155e1561e","503":"837a75a6-153f-453b-8553-7b7eb9066351","504":"1b7ecb3d-c550-4ba6-8e00-12da52af7b12"},"method":"post","type":"path","servers":["d65ea0e6-a32c-42a4-a2ba-541a3761e9ad"],"security":[],"path":"/v1/chains/{chain_name}/orders/collection-bids","baseUrlOptions":["https://api.sandbox.immutable.com"],"title":"Create a collection bid","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d870401d-c5ca-40fe-ad03-9533a0d1775c":{"name":"chain_name","in":"path","required":true,"schema":{"type":"string","description":"The name of chain","example":"imtbl-zkevm-testnet","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_address":{"type":"string","example":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"account_address","typeLabel":"string"},"order_hash":{"type":"string","example":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266","isRequired":true,"uniqueKey":"order_hash","typeLabel":"string"},"buy":{"type":"array","description":"Buy item for collection bid should either be ERC721 or ERC1155 collection item","items":{"oneOf":[{"type":"object","required":["type","contract_address","amount"],"properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is ERC721","example":"ERC721_COLLECTION","enum":["ERC721_COLLECTION"],"isRequired":true,"uniqueKey":"buy.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contract_address":{"type":"string","description":"Address of ERC721 collection","example":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"buy.items.[INDEX].oneOf.0.contract_address","typeLabel":"string"},"amount":{"type":"string","description":"A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).","example":"9750000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"buy.items.[INDEX].oneOf.0.amount","typeLabel":"string"}},"uniqueKey":"buy.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["type","contract_address","amount"],"properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is ERC1155","example":"ERC1155_COLLECTION","enum":["ERC1155_COLLECTION"],"isRequired":true,"uniqueKey":"buy.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contract_address":{"type":"string","description":"Address of ERC1155 collection","example":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"buy.items.[INDEX].oneOf.1.contract_address","typeLabel":"string"},"amount":{"type":"string","description":"A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).","example":"9750000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"buy.items.[INDEX].oneOf.1.amount","typeLabel":"string"}},"uniqueKey":"buy.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"buy.items.[INDEX]","typeLabel":"object"},"example":[{"type":"ERC721_COLLECTION","contract_address":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","amount":"1"}],"minItems":1,"maxItems":1,"isRequired":true,"uniqueKey":"buy","typeLabel":"object[]"},"fees":{"type":"array","description":"Buy fees should only include maker marketplace fees and should be no more than two entries as more entires will incur more gas. It is best practice to have this as few as possible.","items":{"type":"object","properties":{"amount":{"type":"string","description":"Fee payable to recipient upon settlement","example":"2250000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"fees.items.[INDEX].amount","typeLabel":"string"},"type":{"type":"string","description":"Fee type","example":"ROYALTY","enum":["ROYALTY","MAKER_ECOSYSTEM","TAKER_ECOSYSTEM","PROTOCOL"],"isRequired":true,"uniqueKey":"fees.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"recipient_address":{"type":"string","description":"Wallet address of fee recipient","example":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"fees.items.[INDEX].recipient_address","typeLabel":"string"}},"example":{"amount":"2250000000000000000","type":"ROYALTY","recipient_address":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233"},"required":["type","amount","recipient_address"],"uniqueKey":"fees.items.[INDEX]","typeLabel":"object"},"example":[],"minItems":0,"maxItems":2,"isRequired":true,"uniqueKey":"fees","typeLabel":"object[]"},"end_at":{"type":"string","description":"Time after which the Order is considered expired","format":"date-time","example":"2022-03-09T05:00:50.52Z","isRequired":true,"uniqueKey":"end_at","typeLabel":"string\u003cdate-time>"},"protocol_data":{"type":"object","properties":{"order_type":{"type":"string","description":"Seaport order type. Orders containing ERC721 tokens will need to pass in the order type as FULL_RESTRICTED while orders with ERC1155 tokens will need to pass in the order_type as PARTIAL_RESTRICTED","example":"FULL_RESTRICTED","enum":["FULL_RESTRICTED","PARTIAL_RESTRICTED"],"isRequired":true,"uniqueKey":"protocol_data.order_type","typeLabel":"enum\u003cstring>"},"counter":{"type":"string","description":"big.Int or uint256 string for order counter","example":"92315562","isRequired":true,"uniqueKey":"protocol_data.counter","typeLabel":"string"},"zone_address":{"type":"string","description":"Immutable zone address","example":"0x12","isRequired":true,"uniqueKey":"protocol_data.zone_address","typeLabel":"string"},"seaport_address":{"type":"string","description":"Immutable Seaport contract address","example":"0x12","isRequired":true,"uniqueKey":"protocol_data.seaport_address","typeLabel":"string"},"seaport_version":{"type":"string","description":"Immutable Seaport contract version","example":"1.5","isRequired":true,"uniqueKey":"protocol_data.seaport_version","typeLabel":"string"}},"example":{"order_type":"FULL_RESTRICTED","counter":"92315562","zone_address":"0x12","seaport_address":"0x12","seaport_version":"1.5"},"required":["order_type","counter","zone_address","seaport_address","seaport_version"],"isRequired":true,"uniqueKey":"protocol_data","typeLabel":"object"},"salt":{"type":"string","description":"A random value added to the create Order request","example":"12686911856931635052326433555881236148","isRequired":true,"uniqueKey":"salt","typeLabel":"string"},"sell":{"type":"array","description":"Sell item for collection bid should be an ERC20 item","items":{"type":"object","properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is ERC20","example":"ERC20","enum":["ERC20"],"isRequired":true,"uniqueKey":"sell.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"contract_address":{"type":"string","description":"Address of ERC20 token","example":"0x0165878A594ca255338adfa4d48449f69242Eb8F","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"sell.items.[INDEX].contract_address","typeLabel":"string"},"amount":{"type":"string","description":"A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).","example":"9750000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"sell.items.[INDEX].amount","typeLabel":"string"}},"required":["type","contract_address","amount"],"uniqueKey":"sell.items.[INDEX]","typeLabel":"object"},"example":[{"type":"ERC20","contract_address":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","amount":"9750000000000000000"}],"minItems":1,"maxItems":1,"isRequired":true,"uniqueKey":"sell","typeLabel":"object[]"},"signature":{"type":"string","description":"Digital signature generated by the user for the specific Order","example":"0x","isRequired":true,"uniqueKey":"signature","typeLabel":"string"},"start_at":{"type":"string","description":"Time after which Order is considered active","format":"date-time","example":"2022-03-09T05:00:50.52Z","isRequired":true,"uniqueKey":"start_at","typeLabel":"string\u003cdate-time>"}},"example":{"account_address":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266","order_hash":"0x0821933d9391bc9bf11a6010fe84776c84b203abff0c1ad781fb4881409c8770","sell":[{"type":"ERC20","amount":"9750000000000000000","contract_address":"0x0165878A594ca255338adfa4d48449f69242Eb8F"}],"fees":[{"type":"MAKER_ECOSYSTEM","amount":"2250000000000000000","recipient_address":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233"}],"end_at":"2022-03-10T05:00:50.52Z","protocol_data":{"order_type":"FULL_RESTRICTED","counter":"1","zone_address":"0x12","seaport_address":"0x12","seaport_version":"1.5"},"salt":"12686911856931635052326433555881236148","buy":[{"type":"ERC721_COLLECTION","contract_address":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","amount":"1"}],"signature":"0x","start_at":"2022-03-09T05:00:50.52Z"},"required":["account_address","order_hash","buy","sell","fees","end_at","start_at","protocol_data","salt","signature"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"account_address":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266","order_hash":"0x0821933d9391bc9bf11a6010fe84776c84b203abff0c1ad781fb4881409c8770","sell":[{"type":"ERC20","amount":"9750000000000000000","contract_address":"0x0165878A594ca255338adfa4d48449f69242Eb8F"}],"fees":[{"type":"MAKER_ECOSYSTEM","amount":"2250000000000000000","recipient_address":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233"}],"end_at":"2022-03-10T05:00:50.52Z","protocol_data":{"order_type":"FULL_RESTRICTED","counter":"1","zone_address":"0x12","seaport_address":"0x12","seaport_version":"1.5"},"salt":"12686911856931635052326433555881236148","buy":[{"type":"ERC721_COLLECTION","contract_address":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","amount":"1"}],"signature":"0x","start_at":"2022-03-09T05:00:50.52Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a1eeff4a-be21-4db7-a20e-b2e5d988b62e":{"description":"Created response.","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"account_address":{"type":"string","example":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266","isRequired":true,"uniqueKey":"result.account_address","typeLabel":"string"},"buy":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is the native IMX token","example":"NATIVE","enum":["NATIVE"],"isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","description":"A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).","example":"9750000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.0.amount","typeLabel":"string"}},"uniqueKey":"result.buy.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["type","contract_address","amount"],"properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is ERC20","example":"ERC20","enum":["ERC20"],"isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contract_address":{"type":"string","description":"Address of ERC20 token","example":"0x0165878A594ca255338adfa4d48449f69242Eb8F","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.1.contract_address","typeLabel":"string"},"amount":{"type":"string","description":"A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).","example":"9750000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.1.amount","typeLabel":"string"}},"uniqueKey":"result.buy.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["type","contract_address","token_id"],"properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is ERC721","example":"ERC721","enum":["ERC721"],"isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contract_address":{"type":"string","description":"Address of ERC721 token","example":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.2.contract_address","typeLabel":"string"},"token_id":{"type":"string","description":"ID of ERC721 token","example":"1","pattern":"\\d+","isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.2.token_id","typeLabel":"string"}},"uniqueKey":"result.buy.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["type","contract_address","token_id","amount"],"properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is ERC1155","example":"ERC1155","enum":["ERC1155"],"isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contract_address":{"type":"string","description":"Address of ERC1155 token","example":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.3.contract_address","typeLabel":"string"},"token_id":{"type":"string","description":"ID of ERC1155 token","example":"1","pattern":"\\d+","isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.3.token_id","typeLabel":"string"},"amount":{"type":"string","description":"A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).","example":"9750000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.3.amount","typeLabel":"string"}},"uniqueKey":"result.buy.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["type","contract_address","amount"],"properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is ERC721","example":"ERC721_COLLECTION","enum":["ERC721_COLLECTION"],"isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"contract_address":{"type":"string","description":"Address of ERC721 collection","example":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.4.contract_address","typeLabel":"string"},"amount":{"type":"string","description":"A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).","example":"9750000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.4.amount","typeLabel":"string"}},"uniqueKey":"result.buy.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["type","contract_address","amount"],"properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is ERC1155","example":"ERC1155_COLLECTION","enum":["ERC1155_COLLECTION"],"isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"contract_address":{"type":"string","description":"Address of ERC1155 collection","example":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.5.contract_address","typeLabel":"string"},"amount":{"type":"string","description":"A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).","example":"9750000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"result.buy.items.[INDEX].oneOf.5.amount","typeLabel":"string"}},"uniqueKey":"result.buy.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"result.buy.items.[INDEX]","typeLabel":"object"},"example":[{"type":"NATIVE","amount":"9750000000000000000","contract_address":"0x0165878A594ca255338adfa4d48449f69242Eb8F"}],"minItems":1,"maxItems":1,"isRequired":true,"uniqueKey":"result.buy","typeLabel":"object[]"},"fees":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"string","description":"Fee payable to recipient upon settlement","example":"2250000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"result.fees.items.[INDEX].amount","typeLabel":"string"},"type":{"type":"string","description":"Fee type","example":"ROYALTY","enum":["ROYALTY","MAKER_ECOSYSTEM","TAKER_ECOSYSTEM","PROTOCOL"],"isRequired":true,"uniqueKey":"result.fees.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"recipient_address":{"type":"string","description":"Wallet address of fee recipient","example":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"result.fees.items.[INDEX].recipient_address","typeLabel":"string"}},"example":{"amount":"2250000000000000000","type":"ROYALTY","recipient_address":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233"},"required":["type","amount","recipient_address"],"uniqueKey":"result.fees.items.[INDEX]","typeLabel":"object"},"example":[],"minItems":0,"isRequired":true,"uniqueKey":"result.fees","typeLabel":"object[]"},"chain":{"type":"object","description":"The chain details","properties":{"id":{"type":"string","description":"The id of chain","example":"eip155:13372","isRequired":true,"uniqueKey":"result.chain.id","typeLabel":"string"},"name":{"type":"string","description":"The name of chain","example":"imtbl-zkevm-testnet","isRequired":true,"uniqueKey":"result.chain.name","typeLabel":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"result.chain","typeLabel":"object"},"created_at":{"type":"string","description":"Time the Order is created","format":"date-time","example":"2022-03-07T07:20:50.52Z","isRequired":true,"uniqueKey":"result.created_at","typeLabel":"string\u003cdate-time>"},"end_at":{"type":"string","description":"Time after which the Order is considered expired","format":"date-time","example":"2022-03-10T05:00:50.52Z","isRequired":true,"uniqueKey":"result.end_at","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","description":"Global Order identifier","example":"018792C9-4AD7-8EC4-4038-9E05C598534A","isRequired":true,"uniqueKey":"result.id","typeLabel":"string"},"order_hash":{"type":"string","example":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266","isRequired":true,"uniqueKey":"result.order_hash","typeLabel":"string"},"protocol_data":{"type":"object","properties":{"order_type":{"type":"string","description":"Seaport order type. Orders containing ERC721 tokens will need to pass in the order type as FULL_RESTRICTED while orders with ERC1155 tokens will need to pass in the order_type as PARTIAL_RESTRICTED","example":"FULL_RESTRICTED","enum":["FULL_RESTRICTED","PARTIAL_RESTRICTED"],"isRequired":true,"uniqueKey":"result.protocol_data.order_type","typeLabel":"enum\u003cstring>"},"counter":{"type":"string","description":"big.Int or uint256 string for order counter","example":"92315562","isRequired":true,"uniqueKey":"result.protocol_data.counter","typeLabel":"string"},"zone_address":{"type":"string","description":"Immutable zone address","example":"0x12","isRequired":true,"uniqueKey":"result.protocol_data.zone_address","typeLabel":"string"},"seaport_address":{"type":"string","description":"Immutable Seaport contract address","example":"0x12","isRequired":true,"uniqueKey":"result.protocol_data.seaport_address","typeLabel":"string"},"seaport_version":{"type":"string","description":"Immutable Seaport contract version","example":"1.5","isRequired":true,"uniqueKey":"result.protocol_data.seaport_version","typeLabel":"string"}},"example":{"order_type":"FULL_RESTRICTED","counter":"92315562","zone_address":"0x12","seaport_address":"0x12","seaport_version":"1.5"},"required":["order_type","counter","zone_address","seaport_address","seaport_version"],"isRequired":true,"uniqueKey":"result.protocol_data","typeLabel":"object"},"salt":{"type":"string","description":"A random value added to the create Order request","example":"12686911856931635052326433555881236148","isRequired":true,"uniqueKey":"result.salt","typeLabel":"string"},"sell":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is the native IMX token","example":"NATIVE","enum":["NATIVE"],"isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","description":"A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).","example":"9750000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.0.amount","typeLabel":"string"}},"uniqueKey":"result.sell.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["type","contract_address","amount"],"properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is ERC20","example":"ERC20","enum":["ERC20"],"isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contract_address":{"type":"string","description":"Address of ERC20 token","example":"0x0165878A594ca255338adfa4d48449f69242Eb8F","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.1.contract_address","typeLabel":"string"},"amount":{"type":"string","description":"A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).","example":"9750000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.1.amount","typeLabel":"string"}},"uniqueKey":"result.sell.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["type","contract_address","token_id"],"properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is ERC721","example":"ERC721","enum":["ERC721"],"isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contract_address":{"type":"string","description":"Address of ERC721 token","example":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.2.contract_address","typeLabel":"string"},"token_id":{"type":"string","description":"ID of ERC721 token","example":"1","pattern":"\\d+","isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.2.token_id","typeLabel":"string"}},"uniqueKey":"result.sell.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["type","contract_address","token_id","amount"],"properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is ERC1155","example":"ERC1155","enum":["ERC1155"],"isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contract_address":{"type":"string","description":"Address of ERC1155 token","example":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.3.contract_address","typeLabel":"string"},"token_id":{"type":"string","description":"ID of ERC1155 token","example":"1","pattern":"\\d+","isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.3.token_id","typeLabel":"string"},"amount":{"type":"string","description":"A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).","example":"9750000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.3.amount","typeLabel":"string"}},"uniqueKey":"result.sell.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["type","contract_address","amount"],"properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is ERC721","example":"ERC721_COLLECTION","enum":["ERC721_COLLECTION"],"isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"contract_address":{"type":"string","description":"Address of ERC721 collection","example":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.4.contract_address","typeLabel":"string"},"amount":{"type":"string","description":"A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).","example":"9750000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.4.amount","typeLabel":"string"}},"uniqueKey":"result.sell.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["type","contract_address","amount"],"properties":{"type":{"type":"string","description":"Token type user is offering, which in this case is ERC1155","example":"ERC1155_COLLECTION","enum":["ERC1155_COLLECTION"],"isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"},"contract_address":{"type":"string","description":"Address of ERC1155 collection","example":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.5.contract_address","typeLabel":"string"},"amount":{"type":"string","description":"A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).","example":"9750000000000000000","pattern":"\\d+","isRequired":true,"uniqueKey":"result.sell.items.[INDEX].oneOf.5.amount","typeLabel":"string"}},"uniqueKey":"result.sell.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"result.sell.items.[INDEX]","typeLabel":"object"},"example":[{"type":"ERC721","contract_address":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","token_id":"1"}],"minItems":1,"maxItems":1,"isRequired":true,"uniqueKey":"result.sell","typeLabel":"object[]"},"signature":{"type":"string","description":"Digital signature generated by the user for the specific Order","example":"0x","isRequired":true,"uniqueKey":"result.signature","typeLabel":"string"},"start_at":{"type":"string","description":"Time after which Order is considered active","format":"date-time","example":"2022-03-09T05:00:50.52Z","isRequired":true,"uniqueKey":"result.start_at","typeLabel":"string\u003cdate-time>"},"status":{"oneOf":[{"type":"object","description":"The Order status","required":["name","pending","cancellation_type"],"properties":{"name":{"type":"string","description":"The order status indicating a order is has been cancelled or about to be cancelled.","enum":["CANCELLED"],"isRequired":true,"uniqueKey":"result.status.oneOf.0.name","typeLabel":"enum\u003cstring>"},"pending":{"type":"boolean","description":"Whether the cancellation of the order is pending","example":false,"isRequired":true,"uniqueKey":"result.status.oneOf.0.pending","typeLabel":"boolean"},"cancellation_type":{"type":"string","description":"Whether the cancellation was done on-chain or off-chain or as a result of an underfunded account","enum":["ON_CHAIN","OFF_CHAIN","UNDERFUNDED"],"example":"ON_CHAIN","isRequired":true,"uniqueKey":"result.status.oneOf.0.cancellation_type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"result.status.oneOf.0","typeLabel":"object"},{"type":"object","description":"The Order status","required":["name","evaluated","started"],"properties":{"name":{"type":"string","description":"The order status that indicates the order is yet to be active due to various reasons.","enum":["PENDING"],"isRequired":true,"uniqueKey":"result.status.oneOf.1.name","typeLabel":"enum\u003cstring>"},"evaluated":{"type":"boolean","description":"Whether the order has been evaluated after its creation","example":false,"isRequired":true,"uniqueKey":"result.status.oneOf.1.evaluated","typeLabel":"boolean"},"started":{"type":"boolean","description":"Whether the order has reached its specified start time","example":false,"isRequired":true,"uniqueKey":"result.status.oneOf.1.started","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"result.status.oneOf.1","typeLabel":"object"},{"type":"object","description":"The Order status","required":["name"],"properties":{"name":{"type":"string","description":"The order status that indicates an order can be fulfilled.","enum":["ACTIVE"],"isRequired":true,"uniqueKey":"result.status.oneOf.2.name","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"result.status.oneOf.2","typeLabel":"object"},{"type":"object","description":"The Order status","required":["name","sufficient_approvals","sufficient_balances"],"properties":{"name":{"type":"string","description":"The order status that indicates an order cannot be fulfilled.","enum":["INACTIVE"],"isRequired":true,"uniqueKey":"result.status.oneOf.3.name","typeLabel":"enum\u003cstring>"},"sufficient_approvals":{"type":"boolean","description":"Whether the order offerer has sufficient approvals","example":false,"isRequired":true,"uniqueKey":"result.status.oneOf.3.sufficient_approvals","typeLabel":"boolean"},"sufficient_balances":{"type":"boolean","description":"Whether the order offerer still has sufficient balance to complete the order","example":false,"isRequired":true,"uniqueKey":"result.status.oneOf.3.sufficient_balances","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"result.status.oneOf.3","typeLabel":"object"},{"type":"object","description":"The Order status","required":["name"],"properties":{"name":{"type":"string","description":"A terminal order status indicating that an order has been fulfilled.","enum":["FILLED"],"isRequired":true,"uniqueKey":"result.status.oneOf.4.name","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"result.status.oneOf.4","typeLabel":"object"},{"type":"object","description":"The Order status","required":["name"],"properties":{"name":{"type":"string","description":"A terminal order status indicating that an order cannot be fulfilled due to expiry.","enum":["EXPIRED"],"isRequired":true,"uniqueKey":"result.status.oneOf.5.name","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"result.status.oneOf.5","typeLabel":"object"}],"isRequired":true,"uniqueKey":"result.status","typeLabel":"object"},"type":{"type":"string","description":"Order type","example":"LISTING","enum":["LISTING","BID","COLLECTION_BID","TRAIT_BID","METADATA_BID"],"isRequired":true,"uniqueKey":"result.type","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","description":"Time the Order is last updated","format":"date-time","example":"2022-03-07T07:20:50.52Z","isRequired":true,"uniqueKey":"result.updated_at","typeLabel":"string\u003cdate-time>"},"fill_status":{"description":"The ratio of the order that has been filled, an order that has been fully filled will have the same numerator and denominator values.","type":"object","properties":{"numerator":{"type":"string","description":"The numerator of the fill status","example":"1","isRequired":true,"uniqueKey":"result.fill_status.numerator","typeLabel":"string"},"denominator":{"type":"string","description":"The denominator of the fill status","example":"2","isRequired":true,"uniqueKey":"result.fill_status.denominator","typeLabel":"string"}},"required":["numerator","denominator"],"isRequired":true,"uniqueKey":"result.fill_status","typeLabel":"object"},"trait_criteria":{"type":"array","description":"Trait filters for TRAIT_BID orders; omitted for other order types.","items":{"type":"object","description":"A trait filter used to match NFTs by metadata attribute","properties":{"trait_type":{"type":"string","description":"The trait type (attribute name)","example":"Background","isRequired":true,"uniqueKey":"result.trait_criteria.items.[INDEX].trait_type","typeLabel":"string"},"values":{"type":"array","description":"The trait values to match against","items":{"type":"string","uniqueKey":"result.trait_criteria.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"minItems":1,"example":["Blue","Red"],"isRequired":true,"uniqueKey":"result.trait_criteria.items.[INDEX].values","typeLabel":"string[]"}},"required":["trait_type","values"],"uniqueKey":"result.trait_criteria.items.[INDEX]","typeLabel":"object"},"minItems":1,"example":[{"trait_type":"Background","values":["Blue","Red"]}],"uniqueKey":"result.trait_criteria","typeLabel":"object[]"},"metadata_id":{"type":"string","format":"uuid","description":"Metadata identifier for METADATA_BID orders created with a single metadata stack. Omitted for other order types and for metadata bids created with `metadata_criteria`.","example":"018792C9-4AD7-8EC4-4038-9E05C598534B","uniqueKey":"result.metadata_id","typeLabel":"string\u003cuuid>"},"metadata_criteria":{"type":"array","description":"Field-level metadata filters for METADATA_BID orders created with criteria instead of a `metadata_id`. Omitted for other order types and for metadata bids created with a `metadata_id`.","items":{"type":"object","description":"A field-level filter used to match NFTs for a metadata bid. The\n`field_name` is either a top-level metadata field (`name`, `image`,\n`description`, `animation_url`, `external_url`, `youtube_url`) or an\nattribute identified by the `attribute:\u003ctrait_type>` prefix (e.g.\n`attribute:Background`). Values match case-insensitively; multiple\nvalues are OR'd, multiple filters on a bid are AND'd.\n","properties":{"field_name":{"type":"string","description":"The metadata field name (top-level field or `attribute:\u003ctrait_type>`)","example":"attribute:Background","isRequired":true,"uniqueKey":"result.metadata_criteria.items.[INDEX].field_name","typeLabel":"string"},"values":{"type":"array","description":"The metadata field values to match against (OR semantics)","items":{"type":"string","uniqueKey":"result.metadata_criteria.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"minItems":1,"example":["Blue","Red"],"isRequired":true,"uniqueKey":"result.metadata_criteria.items.[INDEX].values","typeLabel":"string[]"}},"required":["field_name","values"],"uniqueKey":"result.metadata_criteria.items.[INDEX]","typeLabel":"object"},"minItems":1,"example":[{"field_name":"name","values":["Cool Dragon"]},{"field_name":"attribute:Background","values":["Blue","Red"]}],"uniqueKey":"result.metadata_criteria","typeLabel":"object[]"}},"example":{"account_address":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266","buy":[{"type":"NATIVE","amount":"9750000000000000000","contract_address":"0x0165878A594ca255338adfa4d48449f69242Eb8F"}],"fees":[],"chain":{"id":"eip155:11155111","name":"sepolia"},"created_at":"2022-03-07T07:20:50.52Z","end_at":"2022-03-10T05:00:50.52Z","id":"018792C9-4AD7-8EC4-4038-9E05C598534A","protocol_data":{"order_type":"FULL_RESTRICTED","counter":"1","zone_address":"0x12","seaport_address":"0x12","seaport_version":"1.4"},"salt":"12686911856931635052326433555881236148","sell":[{"type":"ERC721","contract_address":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","token_id":"1"}],"signature":"0x","start_at":"2022-03-09T05:00:50.52Z","status":{"name":"ACTIVE"},"fill_status":{"numerator":1,"denominator":2},"type":"LISTING","updated_at":"2022-03-07T07:20:50.52Z"},"required":["id","type","account_address","buy","sell","fees","chain","created_at","end_at","start_at","updated_at","order_hash","protocol_data","salt","signature","status","fill_status"],"isRequired":true,"uniqueKey":"result","typeLabel":"object"}},"required":["result"],"example":{"result":{"account_address":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266","sell":[{"type":"ERC20","amount":"9750000000000000000","contract_address":"0x0165878A594ca255338adfa4d48449f69242Eb8F"}],"fees":[],"chain":{"id":"eip155:11155111","name":"sepolia"},"created_at":"2022-03-07T07:20:50.52Z","end_at":"2022-03-10T05:00:50.52Z","id":"018792C9-4AD7-8EC4-4038-9E05C598534A","order_hash":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266","protocol_data":{"order_type":"PARTIAL_RESTRICTED","counter":"1","zone_address":"0x12","seaport_address":"0x12","seaport_version":"1.5"},"salt":"12686911856931635052326433555881236148","buy":[{"type":"ERC721_COLLECTION","contract_address":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","amount":"1"}],"signature":"0x","start_at":"2022-03-09T05:00:50.52Z","status":{"name":"EXPIRED"},"type":"COLLECTION_BID","updated_at":"2022-03-07T07:20:50.52Z"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"result":{"account_address":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266","sell":[{"type":"ERC20","amount":"9750000000000000000","contract_address":"0x0165878A594ca255338adfa4d48449f69242Eb8F"}],"fees":[],"chain":{"id":"eip155:11155111","name":"sepolia"},"created_at":"2022-03-07T07:20:50.52Z","end_at":"2022-03-10T05:00:50.52Z","id":"018792C9-4AD7-8EC4-4038-9E05C598534A","order_hash":"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266","protocol_data":{"order_type":"PARTIAL_RESTRICTED","counter":"1","zone_address":"0x12","seaport_address":"0x12","seaport_version":"1.5"},"salt":"12686911856931635052326433555881236148","buy":[{"type":"ERC721_COLLECTION","contract_address":"0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E","amount":"1"}],"signature":"0x","start_at":"2022-03-09T05:00:50.52Z","status":{"name":"EXPIRED"},"type":"COLLECTION_BID","updated_at":"2022-03-07T07:20:50.52Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"29665e6f-43cb-44fd-867f-80a23465c8d5":{"description":"Bad Request (400)","content":{"application/json":{"schema":{"type":"object","required":["code","details","message","link","trace_id"],"properties":{"message":{"type":"string","description":"Error Message","maxLength":1024,"pattern":"^[\\x20-\\x7E]*$","example":"all fields must be provided","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"link":{"type":"string","format":"uri","description":"Link to IMX documentation that can help resolve this error","maxLength":2048,"example":"https://docs.x.immutable.com/reference/#/","isRequired":true,"uniqueKey":"link","typeLabel":"string\u003curi>"},"trace_id":{"type":"string","description":"Trace ID of the initial request","maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$","example":"e47634b79a5cd6894ddc9639ec4aad26","isRequired":true,"uniqueKey":"trace_id","typeLabel":"string"},"code":{"type":"string","description":"Error Code","enum":["VALIDATION_ERROR"],"example":"VALIDATION_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"details":{"oneOf":[{"type":"object","description":"Additional details to help resolve the error","isRequired":true,"uniqueKey":"details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional details to help resolve the error","isRequired":true,"uniqueKey":"details.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"all fields must be provided","link":"https://docs.x.immutable.com/reference/#/","trace_id":"e47634b79a5cd6894ddc9639ec4aad26","code":"VALIDATION_ERROR","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"576b2a92-389f-40b1-b0e1-81b913817710":{"description":"The specified resource was not found (404)","content":{"application/json":{"schema":{"type":"object","required":["code","details","message","link","trace_id"],"properties":{"message":{"type":"string","description":"Error Message","maxLength":1024,"pattern":"^[\\x20-\\x7E]*$","example":"all fields must be provided","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"link":{"type":"string","format":"uri","description":"Link to IMX documentation that can help resolve this error","maxLength":2048,"example":"https://docs.x.immutable.com/reference/#/","isRequired":true,"uniqueKey":"link","typeLabel":"string\u003curi>"},"trace_id":{"type":"string","description":"Trace ID of the initial request","maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$","example":"e47634b79a5cd6894ddc9639ec4aad26","isRequired":true,"uniqueKey":"trace_id","typeLabel":"string"},"code":{"type":"string","description":"Error Code","enum":["RESOURCE_NOT_FOUND"],"example":"RESOURCE_NOT_FOUND","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"details":{"oneOf":[{"type":"object","description":"Additional details to help resolve the error","isRequired":true,"uniqueKey":"details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional details to help resolve the error","isRequired":true,"uniqueKey":"details.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"all fields must be provided","link":"https://docs.x.immutable.com/reference/#/","trace_id":"e47634b79a5cd6894ddc9639ec4aad26","code":"RESOURCE_NOT_FOUND","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"6a0e34ff-10f2-45a3-ad09-7724d202994e":{"description":"Internal Server Error (500)","content":{"application/json":{"schema":{"type":"object","required":["code","details","message","link","trace_id"],"properties":{"message":{"type":"string","description":"Error Message","maxLength":1024,"pattern":"^[\\x20-\\x7E]*$","example":"all fields must be provided","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"link":{"type":"string","format":"uri","description":"Link to IMX documentation that can help resolve this error","maxLength":2048,"example":"https://docs.x.immutable.com/reference/#/","isRequired":true,"uniqueKey":"link","typeLabel":"string\u003curi>"},"trace_id":{"type":"string","description":"Trace ID of the initial request","maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$","example":"e47634b79a5cd6894ddc9639ec4aad26","isRequired":true,"uniqueKey":"trace_id","typeLabel":"string"},"code":{"type":"string","description":"Error Code","enum":["INTERNAL_SERVER_ERROR"],"example":"INTERNAL_SERVER_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"details":{"oneOf":[{"type":"object","description":"Additional details to help resolve the error","isRequired":true,"uniqueKey":"details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional details to help resolve the error","isRequired":true,"uniqueKey":"details.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"all fields must be provided","link":"https://docs.x.immutable.com/reference/#/","trace_id":"e47634b79a5cd6894ddc9639ec4aad26","code":"INTERNAL_SERVER_ERROR","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"8d73a228-6b01-4599-a0ed-82e155e1561e":{"description":"Not Implemented Error (501)","content":{"application/json":{"schema":{"type":"object","required":["code","details","message","link","trace_id"],"properties":{"message":{"type":"string","description":"Error Message","maxLength":1024,"pattern":"^[\\x20-\\x7E]*$","example":"all fields must be provided","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"link":{"type":"string","format":"uri","description":"Link to IMX documentation that can help resolve this error","maxLength":2048,"example":"https://docs.x.immutable.com/reference/#/","isRequired":true,"uniqueKey":"link","typeLabel":"string\u003curi>"},"trace_id":{"type":"string","description":"Trace ID of the initial request","maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$","example":"e47634b79a5cd6894ddc9639ec4aad26","isRequired":true,"uniqueKey":"trace_id","typeLabel":"string"},"code":{"type":"string","description":"Error Code","enum":["NOT_IMPLEMENTED_ERROR"],"example":"NOT_IMPLEMENTED_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"details":{"oneOf":[{"type":"object","description":"Additional details to help resolve the error","isRequired":true,"uniqueKey":"details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional details to help resolve the error","isRequired":true,"uniqueKey":"details.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"all fields must be provided","link":"https://docs.x.immutable.com/reference/#/","trace_id":"e47634b79a5cd6894ddc9639ec4aad26","code":"NOT_IMPLEMENTED_ERROR","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"837a75a6-153f-453b-8553-7b7eb9066351":{"description":"Service Unavailable (503) - RPC or upstream service temporarily unavailable","content":{"application/json":{"schema":{"type":"object","required":["code","details","message","link","trace_id"],"properties":{"message":{"type":"string","description":"Error Message","maxLength":1024,"pattern":"^[\\x20-\\x7E]*$","example":"all fields must be provided","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"link":{"type":"string","format":"uri","description":"Link to IMX documentation that can help resolve this error","maxLength":2048,"example":"https://docs.x.immutable.com/reference/#/","isRequired":true,"uniqueKey":"link","typeLabel":"string\u003curi>"},"trace_id":{"type":"string","description":"Trace ID of the initial request","maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$","example":"e47634b79a5cd6894ddc9639ec4aad26","isRequired":true,"uniqueKey":"trace_id","typeLabel":"string"},"code":{"type":"string","description":"Error Code","enum":["SERVICE_UNAVAILABLE"],"example":"SERVICE_UNAVAILABLE","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"details":{"oneOf":[{"type":"object","description":"Additional details to help resolve the error","isRequired":true,"uniqueKey":"details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional details to help resolve the error","isRequired":true,"uniqueKey":"details.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"all fields must be provided","link":"https://docs.x.immutable.com/reference/#/","trace_id":"e47634b79a5cd6894ddc9639ec4aad26","code":"SERVICE_UNAVAILABLE","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"1b7ecb3d-c550-4ba6-8e00-12da52af7b12":{"description":"Gateway Timeout (504) - Upstream validation request timed out","content":{"application/json":{"schema":{"type":"object","required":["code","details","message","link","trace_id"],"properties":{"message":{"type":"string","description":"Error Message","maxLength":1024,"pattern":"^[\\x20-\\x7E]*$","example":"all fields must be provided","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"link":{"type":"string","format":"uri","description":"Link to IMX documentation that can help resolve this error","maxLength":2048,"example":"https://docs.x.immutable.com/reference/#/","isRequired":true,"uniqueKey":"link","typeLabel":"string\u003curi>"},"trace_id":{"type":"string","description":"Trace ID of the initial request","maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$","example":"e47634b79a5cd6894ddc9639ec4aad26","isRequired":true,"uniqueKey":"trace_id","typeLabel":"string"},"code":{"type":"string","description":"Error Code","enum":["GATEWAY_TIMEOUT"],"example":"GATEWAY_TIMEOUT","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"details":{"oneOf":[{"type":"object","description":"Additional details to help resolve the error","isRequired":true,"uniqueKey":"details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional details to help resolve the error","isRequired":true,"uniqueKey":"details.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"all fields must be provided","link":"https://docs.x.immutable.com/reference/#/","trace_id":"e47634b79a5cd6894ddc9639ec4aad26","code":"GATEWAY_TIMEOUT","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"d65ea0e6-a32c-42a4-a2ba-541a3761e9ad":{"url":"https://api.sandbox.immutable.com"}}},"originalFileLocation":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json"},"subdomain":"immutable-b818fae7","siteName":"Documentation","title":"Create a collection bid - Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-05T23:34:44.514Z","originalFileLocation":"api-reference/orders/create-a-collection-bid.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a collection bid\">\u003cmeta data-mint-head name=\"application-name\" content=\"Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/immutable-b818fae7/x-EOE1PxIcz1ImLD/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/immutable-b818fae7/x-EOE1PxIcz1ImLD/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/immutable-b818fae7/x-EOE1PxIcz1ImLD/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/immutable-b818fae7/x-EOE1PxIcz1ImLD/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/immutable-b818fae7/x-EOE1PxIcz1ImLD/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/immutable-b818fae7/x-EOE1PxIcz1ImLD/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/immutable-b818fae7/x-EOE1PxIcz1ImLD/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/immutable-b818fae7/x-EOE1PxIcz1ImLD/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/immutable-b818fae7/x-EOE1PxIcz1ImLD/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a collection bid - Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a collection bid\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.immutable.com/api-reference/orders/create-a-collection-bid\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://immutable-b818fae7.mintlify.app/_mintlify/api/og/v2?division=orders\u0026amp;title=Create+a+collection+bid\u0026amp;description=Create+a+collection+bid\u0026amp;theme=839b73dc98d439dd3727096a\u0026amp;signature=e6d05bf6041f0efd3957bc0887fbe8a192acdd4b18437d5c040be965bce6cc0a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a collection bid - Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a collection bid\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://immutable-b818fae7.mintlify.app/_mintlify/api/og/v2?division=orders\u0026amp;title=Create+a+collection+bid\u0026amp;description=Create+a+collection+bid\u0026amp;theme=839b73dc98d439dd3727096a\u0026amp;signature=e6d05bf6041f0efd3957bc0887fbe8a192acdd4b18437d5c040be965bce6cc0a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/immutable-b818fae7/x-EOE1PxIcz1ImLD/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#F5B941\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.immutable.com/api-reference/orders/create-a-collection-bid\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/orders/create-a-collection-bid.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.immutable.com/#organization\",\"name\":\"Documentation\",\"url\":\"https://docs.immutable.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/immutable-b818fae7/aPl7c1S4nykO3QqA/logo/light.svg?fit=max\u0026auto=format\u0026n=aPl7c1S4nykO3QqA\u0026q=85\u0026s=6acd3ff9f0fe8cceb4285c3e8817ebd7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.immutable.com#website\",\"name\":\"Documentation\",\"url\":\"https://docs.immutable.com\",\"publisher\":{\"@id\":\"https://docs.immutable.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.immutable.com/api-reference/orders/create-a-collection-bid#webpage\",\"url\":\"https://docs.immutable.com/api-reference/orders/create-a-collection-bid\",\"name\":\"Create a collection bid\",\"description\":\"Create a collection bid\",\"dateModified\":\"2026-08-05T23:34:44.514Z\",\"isPartOf\":{\"@id\":\"https://docs.immutable.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.immutable.com/api-reference/orders/create-a-collection-bid#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.immutable.com/api-reference/orders/create-a-collection-bid#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Blockchain\",\"item\":\"https://docs.immutable.com/api-reference/activities/list-history-of-activities\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"orders\",\"item\":\"https://docs.immutable.com/api-reference/orders/cancel-one-or-more-orders\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a collection bid\",\"item\":\"https://docs.immutable.com/api-reference/orders/create-a-collection-bid\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.immutable.com/api-reference/orders/create-a-collection-bid#apireference\",\"headline\":\"Create a collection bid\",\"name\":\"Create a collection bid\",\"description\":\"Create a collection bid\",\"url\":\"https://docs.immutable.com/api-reference/orders/create-a-collection-bid\",\"mainEntityOfPage\":{\"@id\":\"https://docs.immutable.com/api-reference/orders/create-a-collection-bid#webpage\"},\"dateModified\":\"2026-08-05T23:34:44.514Z\",\"publisher\":{\"@id\":\"https://docs.immutable.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.immutable.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Documentation","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/docs/immutable"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/docs/sdks/game-bridge-architecture"}]},{"tab":"API Reference","groups":[{"group":"Blockchain","pages":[{"group":"activities","pages":[{"title":"List history of activities","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/activity-history","href":"/api-reference/activities/list-history-of-activities"},{"title":"List all activities","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/activities","href":"/api-reference/activities/list-all-activities"},{"title":"Get a single activity by ID","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/activities/{activity_id}","href":"/api-reference/activities/get-a-single-activity-by-id"}]},{"group":"collections","pages":[{"title":"List all collections","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/collections","href":"/api-reference/collections/list-all-collections"},{"title":"Get collection by contract address","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/collections/{contract_address}","href":"/api-reference/collections/get-collection-by-contract-address"},{"title":"Refresh collection metadata","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/chains/{chain_name}/collections/{contract_address}/refresh-metadata","href":"/api-reference/collections/refresh-collection-metadata"},{"title":"List collections by NFT owner","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/accounts/{account_address}/collections","href":"/api-reference/collections/list-collections-by-nft-owner"},{"title":"Refresh collection metadata internal","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/internal/chains/{chain_name}/environment/{environment}/collections/{contract_address}/refresh-metadata","href":"/api-reference/collections/refresh-collection-metadata-internal"}]},{"group":"nfts","pages":[{"title":"Get NFT by token ID","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/collections/{contract_address}/nfts/{token_id}","href":"/api-reference/nfts/get-nft-by-token-id"},{"title":"List NFTs by contract address","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/collections/{contract_address}/nfts","href":"/api-reference/nfts/list-nfts-by-contract-address"},{"title":"List NFTs by account address","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/accounts/{account_address}/nfts","href":"/api-reference/nfts/list-nfts-by-account-address"},{"title":"List all NFTs","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/nfts","href":"/api-reference/nfts/list-all-nfts"},{"title":"List mint requests","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/collections/{contract_address}/nfts/mint-requests","href":"/api-reference/nfts/list-mint-requests"},{"title":"Mint NFTs","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/chains/{chain_name}/collections/{contract_address}/nfts/mint-requests","href":"/api-reference/nfts/mint-nfts"},{"title":"Get mint request by reference ID","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/collections/{contract_address}/nfts/mint-requests/{reference_id}","href":"/api-reference/nfts/get-mint-request-by-reference-id"}]},{"group":"metadata","pages":[{"title":"Get metadata by ID","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/collections/{contract_address}/metadata/{metadata_id}","href":"/api-reference/metadata/get-metadata-by-id"},{"title":"Get a list of metadata from the given contract","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/collections/{contract_address}/metadata","href":"/api-reference/metadata/get-a-list-of-metadata-from-the-given-contract"},{"title":"Get a list of metadata from the given chain","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/metadata","href":"/api-reference/metadata/get-a-list-of-metadata-from-the-given-chain"},{"title":"Refresh stacked metadata","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/chains/{chain_name}/collections/{contract_address}/metadata/refresh-metadata","href":"/api-reference/metadata/refresh-stacked-metadata"},{"title":"Refresh NFT metadata","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/chains/{chain_name}/collections/{contract_address}/nfts/refresh-metadata","href":"/api-reference/metadata/refresh-nft-metadata"},{"title":"List NFT stack bundles by stack_id. Response will include Market, Listings \u0026 Stack Count information for each stack","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/stacks","href":"/api-reference/metadata/list-nft-stack-bundles-by-stack_id-response-will-include-market-listings-\u0026-stack-count-information-for-each-stack"}]},{"group":"nft owners","pages":[{"title":"List NFT owners by token ID","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/collections/{contract_address}/nfts/{token_id}/owners","href":"/api-reference/nft-owners/list-nft-owners-by-token-id"},{"title":"List all NFT owners","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/nft-owners","href":"/api-reference/nft-owners/list-all-nft-owners"},{"title":"List owners by contract address","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/collections/{contract_address}/owners","href":"/api-reference/nft-owners/list-owners-by-contract-address"}]},{"group":"tokens","pages":[{"title":"List ERC20 tokens","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/tokens","href":"/api-reference/tokens/list-erc20-tokens"},{"title":"Get single ERC20 token","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/tokens/{contract_address}","href":"/api-reference/tokens/get-single-erc20-token"}]},{"group":"chains","pages":[{"title":"List supported chains","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains","href":"/api-reference/chains/list-supported-chains"}]},{"group":"crafting","pages":[{"title":"Sign a crafting payload","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/chains/{chain_name}/crafting/sign","href":"/api-reference/crafting/sign-a-crafting-payload"}]},{"group":"orders","pages":[{"title":"Cancel one or more orders","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/chains/{chain_name}/orders/cancel","href":"/api-reference/orders/cancel-one-or-more-orders"},{"title":"List all listings","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/orders/listings","href":"/api-reference/orders/list-all-listings"},{"title":"Create a listing","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/chains/{chain_name}/orders/listings","href":"/api-reference/orders/create-a-listing"},{"title":"List all bids","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/orders/bids","href":"/api-reference/orders/list-all-bids"},{"title":"Create a bid","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/chains/{chain_name}/orders/bids","href":"/api-reference/orders/create-a-bid"},{"title":"List all collection bids","description":"List all collection bids","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/orders/collection-bids","href":"/api-reference/orders/list-all-collection-bids"},{"title":"Create a collection bid","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/chains/{chain_name}/orders/collection-bids","href":"/api-reference/orders/create-a-collection-bid"},{"title":"List all trait bids","description":"List all trait bids","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/orders/trait-bids","href":"/api-reference/orders/list-all-trait-bids"},{"title":"Create a trait bid","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/chains/{chain_name}/orders/trait-bids","href":"/api-reference/orders/create-a-trait-bid"},{"title":"List all metadata bids","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/orders/metadata-bids","href":"/api-reference/orders/list-all-metadata-bids"},{"title":"Create a metadata bid","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/chains/{chain_name}/orders/metadata-bids","href":"/api-reference/orders/create-a-metadata-bid"},{"title":"Get a single trait bid by ID","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/orders/trait-bids/{trait_bid_id}","href":"/api-reference/orders/get-a-single-trait-bid-by-id"},{"title":"Get a single metadata bid by ID","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/orders/metadata-bids/{metadata_bid_id}","href":"/api-reference/orders/get-a-single-metadata-bid-by-id"},{"title":"Get a single listing by ID","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/orders/listings/{listing_id}","href":"/api-reference/orders/get-a-single-listing-by-id"},{"title":"Get a single bid by ID","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/orders/bids/{bid_id}","href":"/api-reference/orders/get-a-single-bid-by-id"},{"title":"Get a single collection bid by ID","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/orders/collection-bids/{collection_bid_id}","href":"/api-reference/orders/get-a-single-collection-bid-by-id"},{"title":"Retrieve fulfillment data for orders","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /v1/chains/{chain_name}/orders/fulfillment-data","href":"/api-reference/orders/retrieve-fulfillment-data-for-orders"},{"title":"List all trades","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/trades","href":"/api-reference/orders/list-all-trades"},{"title":"Get a single trade by ID","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/trades/{trade_id}","href":"/api-reference/orders/get-a-single-trade-by-id"}]},{"group":"passport","pages":[{"title":"Get Ethereum linked addresses for a user","deprecated":true,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/passport/users/{user_id}/linked-addresses","href":"/api-reference/passport/get-ethereum-linked-addresses-for-a-user"}]},{"group":"passport profile","pages":[{"title":"Verify phone OTP code against user phone number","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /passport-profile/v1/phone-otp/verify","href":"/api-reference/passport-profile/verify-phone-otp-code-against-user-phone-number"},{"title":"Get profile for authenticated user","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /passport-profile/v1/profile","href":"/api-reference/passport-profile/get-profile-for-authenticated-user"},{"title":"Update username","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /passport-profile/v1/username","href":"/api-reference/passport-profile/update-username"},{"title":"Send phone OTP code for user supplied phone number","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /passport-profile/v1/phone-otp","href":"/api-reference/passport-profile/send-phone-otp-code-for-user-supplied-phone-number"},{"title":"Link wallet v2","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json post /passport-profile/v2/linked-wallets","href":"/api-reference/passport-profile/link-wallet-v2"},{"title":"Get all info for a Passport user","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /passport-profile/v1/user/info","href":"/api-reference/passport-profile/get-all-info-for-a-passport-user"}]},{"group":"metadata-search","pages":[{"title":"Get list of metadata attribute filters","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/search/filters/{contract_address}","href":"/api-reference/metadata-search/get-list-of-metadata-attribute-filters"},{"title":"Search NFTs","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/search/nfts","href":"/api-reference/metadata-search/search-nfts"},{"title":"Search NFT stacks","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/search/stacks","href":"/api-reference/metadata-search/search-nft-stacks"}]},{"group":"pricing","pages":[{"title":"Get pricing data for a list of stack ids","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/quotes/{contract_address}/stacks","href":"/api-reference/pricing/get-pricing-data-for-a-list-of-stack-ids"},{"title":"Get pricing data for a list of token ids","deprecated":null,"version":null,"openapi":"https://imx-openapiv3-mr-sandbox.s3.us-east-2.amazonaws.com/openapi.json get /v1/chains/{chain_name}/quotes/{contract_address}/nfts","href":"/api-reference/pricing/get-pricing-data-for-a-list-of-token-ids"}]}]},{"group":"Audience","pages":[{"group":"ingest","pages":[{"title":"Ingest audience messages","deprecated":null,"version":null,"openapi":"/api-specs/audience.json post /v1/audience/messages","href":"/api-reference/ingest/ingest-audience-messages"}]},{"group":"tracking-consent","pages":[{"title":"Get tracking consent status","deprecated":null,"version":null,"openapi":"/api-specs/audience.json get /v1/audience/tracking-consent","href":"/api-reference/tracking-consent/get-tracking-consent-status"},{"title":"Update tracking consent status","deprecated":null,"version":null,"openapi":"/api-specs/audience.json put /v1/audience/tracking-consent","href":"/api-reference/tracking-consent/update-tracking-consent-status"}]},{"group":"data","pages":[{"title":"Request erasure of all data for an identity","deprecated":null,"version":null,"openapi":"/api-specs/audience.json delete /v1/audience/data","href":"/api-reference/data/request-erasure-of-all-data-for-an-identity"}]}]}]}]},"title":"Create a collection bid - Documentation","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}