{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Swaps API Documentation","description":"Swaps is the execution layer for moving value across chains: swaps, bridges, cross-chain contract calls, prediction market trading, and dedicated stableswap liquidity — behind one API. Users transact with any token on any chain; Swaps handles routing, transaction construction, and end-to-end tracking.","colors":{"primary":"#6366F1","light":"#8B5CF6","dark":"#4F46E5"},"logo":{"light":"https://mintcdn.com/swaps/0Y1Q5nsbTP7RcDGa/logo/light.svg?fit=max\u0026auto=format\u0026n=0Y1Q5nsbTP7RcDGa\u0026q=85\u0026s=b4ef18d882340b146df26c61511553d2","dark":"https://mintcdn.com/swaps/0Y1Q5nsbTP7RcDGa/logo/dark.svg?fit=max\u0026auto=format\u0026n=0Y1Q5nsbTP7RcDGa\u0026q=85\u0026s=59d4110408236ccb8bf596629a4999a0"},"favicon":"https://mintcdn.com/swaps/0Y1Q5nsbTP7RcDGa/favicon.svg?fit=max\u0026auto=format\u0026n=0Y1Q5nsbTP7RcDGa\u0026q=85\u0026s=0cd613f8ed2a18d7e151a1c01caa9db5","navbar":{"primary":{"type":"button","label":"Get Started","href":"https://dashboard.moonpay.com/signup"}},"footer":{"socials":{"x":"https://x.com/moonpay","linkedin":"https://www.linkedin.com/company/moonpay"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"swaps","hasAudioNarration":false,"actualSubdomain":"swaps","customDomains":["docs.swaps.xyz"],"gitSource":{"type":"github","owner":"swaps-xyz","repo":"box-monorepo","deployBranch":"main","contentDirectory":"apps/box-docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad7945dd201333bc5d36e53","collectionId":"986309f2-3617-4b94-a80e-23119a550aa4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad7945dd201333bc5d36e53"},"entitlements":{},"buildId":"6ad7945dd201333bc5d36e53","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"Prediction Market Reference","count":24},{"language":"default","tag":"Documentation","count":10},{"language":"default","tag":"Swap API Reference","count":10},{"language":"default","tag":"Trading","count":8},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Getting Started","count":6},{"language":"default","tag":"User Positions \u0026 Activity","count":5},{"language":"default","tag":"Market Information","count":4},{"language":"default","tag":"Core","count":4},{"language":"default","tag":"Protocol Reference","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"workos-sso-scim","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},{"name":"turbopuffer-dual-write","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":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"prediction-market-reference/get-workflow-status","slug":"/prediction-market-reference/get-workflow-status","pageMetadata":{"title":"Get Workflow Status","description":"Retrieves the status of a workflow transaction by transaction ID.","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/getStatus","href":"/prediction-market-reference/get-workflow-status","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: \"Retrieves the status of a workflow transaction by transaction ID.\"\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":"Get Workflow Status","description":"Retrieves the status of a workflow transaction by transaction ID.","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/getStatus","href":"/prediction-market-reference/get-workflow-status","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get Workflow Status","description":"Retrieves the status of a workflow transaction by transaction ID.","operationId":"getWorkflowStatus","parameters":["3a0693a8-039a-4a0e-a262-f00c0862b0e4"],"responses":{"200":"903372f3-c518-41d8-b952-394045c2f4bd","400":"22948f56-1a42-4db7-8b5c-d7d46f05cb7f","404":"0f8357da-50a2-46b8-bd24-5e567450f908","500":"96f872fe-60da-465d-8e4b-87d916d61648"},"method":"get","type":"path","servers":["23cfa1ea-51ed-491e-a68d-f63bc5e6ca0b"],"security":["f4caf088-94f7-40ce-966f-ba0b84e77084"],"path":"/api/workflows/getStatus","baseUrlOptions":["https://api-v2.swaps.xyz"],"title":"Get Workflow Status","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3a0693a8-039a-4a0e-a262-f00c0862b0e4":{"name":"txId","in":"query","description":"Transaction ID from /getAction request","required":true,"schema":{"type":"string","example":"0x1b121f30eeddfc1ee3eeb491c02be6c4b676b0ac0ac3e309fa25f010172c5af4","isRequired":true,"description":"Transaction ID from /getAction request","uniqueKey":"","typeLabel":"string"}}},"responses":{"903372f3-c518-41d8-b952-394045c2f4bd":{"description":"Workflow status response","content":{"application/json":{"schema":{"type":"object","required":["txId","status","operation","timestamp","name","data"],"properties":{"txId":{"type":"string","description":"Transaction ID","example":"0x36f51092bdfb6f9793fefd9b2d27529fbf7362b48ded9acb7fa4cc7aea03aeca","isRequired":true,"uniqueKey":"txId","typeLabel":"string"},"status":{"type":"string","enum":["success","failed","pending"],"description":"Workflow status","example":"success","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"operation":{"type":"string","description":"Operation type","example":"placeOrder","isRequired":true,"uniqueKey":"operation","typeLabel":"string"},"timestamp":{"type":"integer","description":"Unix timestamp when workflow was executed","example":1765593597,"isRequired":true,"uniqueKey":"timestamp","typeLabel":"integer"},"name":{"type":"string","description":"Workflow name","example":"polymarket","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"data":{"oneOf":[{"type":"object","title":"Polymarket Data","description":"Workflow-specific data","required":["userId","orderRequest","orderResponse"],"properties":{"userId":{"type":"string","description":"Polymarket user ID","example":"0x0797bfec6d2d4f733d461bbee8125805e9e9c892","isRequired":true,"uniqueKey":"data.oneOf.0.userId","typeLabel":"string"},"orderRequest":{"type":"object","required":["side","tokenID","orderType","feeRateBps","slippage","tickSize","negRisk"],"properties":{"side":{"type":"string","enum":["BUY","SELL"],"description":"Order side","isRequired":true,"uniqueKey":"data.oneOf.0.orderRequest.side","typeLabel":"enum\u003cstring>"},"tokenID":{"type":"string","description":"Polymarket CLOB token ID","example":"110902308091723190012269532299497167125504426554890434343419495764557291673806","isRequired":true,"uniqueKey":"data.oneOf.0.orderRequest.tokenID","typeLabel":"string"},"orderType":{"type":"string","enum":["FOK","FAK","GTC","GTD"],"description":"Order type (FOK/FAK are market orders, GTC/GTD are limit orders)","isRequired":true,"uniqueKey":"data.oneOf.0.orderRequest.orderType","typeLabel":"enum\u003cstring>"},"feeRateBps":{"type":"number","minimum":0,"description":"Fee rate in basis points","example":0,"isRequired":true,"uniqueKey":"data.oneOf.0.orderRequest.feeRateBps","typeLabel":"number"},"slippage":{"type":"number","description":"Slippage tolerance in basis points","example":100,"isRequired":true,"uniqueKey":"data.oneOf.0.orderRequest.slippage","typeLabel":"number"},"tickSize":{"type":"string","enum":["0.01","0.001","0.0001"],"description":"Price tick size","isRequired":true,"uniqueKey":"data.oneOf.0.orderRequest.tickSize","typeLabel":"enum\u003cstring>"},"negRisk":{"type":"boolean","description":"Negative risk flag","isRequired":true,"uniqueKey":"data.oneOf.0.orderRequest.negRisk","typeLabel":"boolean"},"amount":{"type":"number","description":"Amount for market orders (FOK/FAK)","example":5,"uniqueKey":"data.oneOf.0.orderRequest.amount","typeLabel":"number"},"price":{"type":"number","minimum":0,"maximum":1,"description":"Price per share (0-1) - required for limit orders, optional for market orders","example":0.021,"uniqueKey":"data.oneOf.0.orderRequest.price","typeLabel":"number"},"size":{"type":"number","minimum":0,"description":"Number of shares for limit orders","example":5,"uniqueKey":"data.oneOf.0.orderRequest.size","typeLabel":"number"}},"isRequired":true,"uniqueKey":"data.oneOf.0.orderRequest","typeLabel":"object"},"orderResponse":{"oneOf":[{"type":"object","title":"Open Order","description":"Order response from Polymarket","required":["id","status","owner","maker_address","market","asset_id","side","original_size","size_matched","price","outcome","created_at","expiration","order_type","associate_trades"],"properties":{"id":{"type":"string","description":"Order ID","example":"0xbd2f3c625c1f6f918a74e8645c3afee9e8f2c5adf91f178efa5e1b65f74fb489","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.id","typeLabel":"string"},"status":{"type":"string","description":"Order status","example":"MATCHED","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.status","typeLabel":"string"},"owner":{"type":"string","description":"Owner ID","example":"258f7485-b93f-52e5-2327-a53c49a299c1","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.owner","typeLabel":"string"},"maker_address":{"type":"string","description":"Maker address","example":"0xBEDcAD563ddf52391573a016Bc5EC7A334Eec756","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.maker_address","typeLabel":"string"},"market":{"type":"string","description":"Market ID","example":"0xb050c89e1e5738c79e117d28da1f057ac2f193511aab87a01b517b466c7265dc","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.market","typeLabel":"string"},"asset_id":{"type":"string","description":"Asset ID (token ID)","example":"110902308091723190012269532299497167125504426554890434343419495764557291673806","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.asset_id","typeLabel":"string"},"side":{"type":"string","enum":["BUY","SELL"],"description":"Order side","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.side","typeLabel":"enum\u003cstring>"},"original_size":{"type":"string","description":"Original order size","example":"5","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.original_size","typeLabel":"string"},"size_matched":{"type":"string","description":"Size matched","example":"0","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.size_matched","typeLabel":"string"},"price":{"type":"string","description":"Order price","example":"0.02","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.price","typeLabel":"string"},"outcome":{"type":"string","description":"Order outcome","example":"No","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.outcome","typeLabel":"string"},"expiration":{"type":"string","description":"Expiration timestamp","example":"1763996360","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.expiration","typeLabel":"string"},"order_type":{"type":"string","description":"Order type","example":"GTD","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.order_type","typeLabel":"string"},"associate_trades":{"type":"array","items":{"type":"string","uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.associate_trades.items.[INDEX]","typeLabel":"string"},"description":"Associated trade IDs","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.associate_trades","typeLabel":"string[]"},"created_at":{"type":"integer","description":"Unix timestamp when order was created","example":1763996291,"isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0.created_at","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.0","typeLabel":"Open Order · object"},{"type":"object","title":"Error Response","description":"Order response from Polymarket","required":["error","status"],"properties":{"error":{"type":"string","description":"Error message","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.1.error","typeLabel":"string"},"status":{"type":"string","description":"Order status","isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.1.status","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse.oneOf.1","typeLabel":"Error Response · object"}],"isRequired":true,"uniqueKey":"data.oneOf.0.orderResponse","typeLabel":"Open Order · object | Error Response · object"},"relayTx":{"oneOf":[{"type":"object","properties":{"txHash":{"type":"string","description":"Transaction hash of the relay transaction","uniqueKey":"data.oneOf.0.relayTx.oneOf.0.txHash","typeLabel":"string"},"status":{"type":"string","description":"Status of the relay transaction","uniqueKey":"data.oneOf.0.relayTx.oneOf.0.status","typeLabel":"string"}},"description":"Relay transaction details (null if not applicable)","uniqueKey":"data.oneOf.0.relayTx.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"txHash":{"type":"string","description":"Transaction hash of the relay transaction"},"status":{"type":"string","description":"Status of the relay transaction"}},"description":"Relay transaction details (null if not applicable)","uniqueKey":"data.oneOf.0.relayTx.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.relayTx","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"data.oneOf.0","typeLabel":"Polymarket Data · object"},{"type":"object","title":"Generic Workflow Data","description":"Workflow-specific data","additionalProperties":true,"isRequired":true,"uniqueKey":"data.oneOf.1","typeLabel":"Generic Workflow Data · object"}],"isRequired":true,"uniqueKey":"data","typeLabel":"Polymarket Data · object | Generic Workflow Data · object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"txId":"0x36f51092bdfb6f9793fefd9b2d27529fbf7362b48ded9acb7fa4cc7aea03aeca","status":"success","operation":"placeOrder","timestamp":1765593597,"name":"polymarket","data":{"userId":"0x0797bfec6d2d4f733d461bbee8125805e9e9c892","orderRequest":{"side":"BUY","tokenID":"110902308091723190012269532299497167125504426554890434343419495764557291673806","orderType":"FOK","feeRateBps":0,"slippage":100,"tickSize":"0.01","negRisk":true,"amount":5,"price":0.021,"size":5},"orderResponse":{"id":"0xbd2f3c625c1f6f918a74e8645c3afee9e8f2c5adf91f178efa5e1b65f74fb489","status":"MATCHED","owner":"258f7485-b93f-52e5-2327-a53c49a299c1","maker_address":"0xBEDcAD563ddf52391573a016Bc5EC7A334Eec756","market":"0xb050c89e1e5738c79e117d28da1f057ac2f193511aab87a01b517b466c7265dc","asset_id":"110902308091723190012269532299497167125504426554890434343419495764557291673806","side":"BUY","original_size":"5","size_matched":"0","price":"0.02","outcome":"No","expiration":"1763996360","order_type":"GTD","associate_trades":["\u003cstring>"],"created_at":1763996291},"relayTx":{"txHash":"\u003cstring>","status":"\u003cstring>"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"22948f56-1a42-4db7-8b5c-d7d46f05cb7f":{"description":"Bad request due to missing or invalid parameters","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","description":"Always false for error responses","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","name","message","title","statusCode","timestamp"],"properties":{"code":{"type":"string","description":"Error type code for programmatic handling","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"name":{"type":"string","description":"Error class name","isRequired":true,"uniqueKey":"error.name","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"title":{"type":"string","description":"Short, user-friendly error title","isRequired":true,"uniqueKey":"error.title","typeLabel":"string"},"statusCode":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"error.statusCode","typeLabel":"integer"},"timestamp":{"type":"string","description":"ISO 8601 timestamp when the error occurred","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","name":"\u003cstring>","message":"\u003cstring>","title":"\u003cstring>","statusCode":123,"timestamp":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"0f8357da-50a2-46b8-bd24-5e567450f908":{"description":"Workflow not found","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","description":"Always false for error responses","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","name","message","title","statusCode","timestamp"],"properties":{"code":{"type":"string","description":"Error type code for programmatic handling","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"name":{"type":"string","description":"Error class name","isRequired":true,"uniqueKey":"error.name","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"title":{"type":"string","description":"Short, user-friendly error title","isRequired":true,"uniqueKey":"error.title","typeLabel":"string"},"statusCode":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"error.statusCode","typeLabel":"integer"},"timestamp":{"type":"string","description":"ISO 8601 timestamp when the error occurred","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","name":"\u003cstring>","message":"\u003cstring>","title":"\u003cstring>","statusCode":123,"timestamp":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"96f872fe-60da-465d-8e4b-87d916d61648":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","description":"Always false for error responses","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","name","message","title","statusCode","timestamp"],"properties":{"code":{"type":"string","description":"Error type code for programmatic handling","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"name":{"type":"string","description":"Error class name","isRequired":true,"uniqueKey":"error.name","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"title":{"type":"string","description":"Short, user-friendly error title","isRequired":true,"uniqueKey":"error.title","typeLabel":"string"},"statusCode":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"error.statusCode","typeLabel":"integer"},"timestamp":{"type":"string","description":"ISO 8601 timestamp when the error occurred","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","name":"\u003cstring>","message":"\u003cstring>","title":"\u003cstring>","statusCode":123,"timestamp":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f4caf088-94f7-40ce-966f-ba0b84e77084":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. Contact Swaps.xyz to obtain an API key.","scopes":[]}}},"servers":{"23cfa1ea-51ed-491e-a68d-f63bc5e6ca0b":{"url":"https://api-v2.swaps.xyz","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. Contact Swaps.xyz to obtain an API key.","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"API key for authentication. Contact Swaps.xyz to obtain an API key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"prediction-market-reference/openapi.json"},"subdomain":"swaps","siteName":"Swaps API Documentation","title":"Get Workflow Status - Swaps API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-06T23:49:39.545Z","originalFileLocation":"prediction-market-reference/get-workflow-status.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=\"system\"}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=\"Retrieves the status of a workflow transaction by transaction ID.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Swaps API 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/swaps/GMGSy86BYr2YqEGa/_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/swaps/GMGSy86BYr2YqEGa/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/swaps/GMGSy86BYr2YqEGa/_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/swaps/GMGSy86BYr2YqEGa/_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/swaps/GMGSy86BYr2YqEGa/_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/swaps/GMGSy86BYr2YqEGa/_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/swaps/GMGSy86BYr2YqEGa/_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/swaps/GMGSy86BYr2YqEGa/_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/swaps/GMGSy86BYr2YqEGa/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Workflow Status - Swaps API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves the status of a workflow transaction by transaction ID.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Swaps API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.swaps.xyz/prediction-market-reference/get-workflow-status\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://swaps.mintlify.app/_mintlify/api/og/v2?division=Trading\u0026amp;title=Get+Workflow+Status\u0026amp;description=Retrieves+the+status+of+a+workflow+transaction+by+transaction+ID.\u0026amp;theme=e402633778683274be5dc99a\u0026amp;signature=6bb467f2fbb1e22d2c5d6c34fad6e6f0c1a0a4af622f44bf32a058cea6f41788\">\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=\"Get Workflow Status - Swaps API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves the status of a workflow transaction by transaction ID.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://swaps.mintlify.app/_mintlify/api/og/v2?division=Trading\u0026amp;title=Get+Workflow+Status\u0026amp;description=Retrieves+the+status+of+a+workflow+transaction+by+transaction+ID.\u0026amp;theme=e402633778683274be5dc99a\u0026amp;signature=6bb467f2fbb1e22d2c5d6c34fad6e6f0c1a0a4af622f44bf32a058cea6f41788\">\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/swaps/GMGSy86BYr2YqEGa/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Swaps API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366F1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.swaps.xyz/prediction-market-reference/get-workflow-status\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/prediction-market-reference/get-workflow-status.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.swaps.xyz/#organization\",\"name\":\"Swaps API Documentation\",\"url\":\"https://docs.swaps.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/swaps/0Y1Q5nsbTP7RcDGa/logo/light.svg?fit=max\u0026auto=format\u0026n=0Y1Q5nsbTP7RcDGa\u0026q=85\u0026s=b4ef18d882340b146df26c61511553d2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.swaps.xyz#website\",\"name\":\"Swaps API Documentation\",\"url\":\"https://docs.swaps.xyz\",\"publisher\":{\"@id\":\"https://docs.swaps.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.swaps.xyz/prediction-market-reference/get-workflow-status#webpage\",\"url\":\"https://docs.swaps.xyz/prediction-market-reference/get-workflow-status\",\"name\":\"Get Workflow Status\",\"description\":\"Retrieves the status of a workflow transaction by transaction ID.\",\"dateModified\":\"2026-08-06T23:49:39.545Z\",\"isPartOf\":{\"@id\":\"https://docs.swaps.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.swaps.xyz/prediction-market-reference/get-workflow-status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.swaps.xyz/prediction-market-reference/get-workflow-status#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Trading\",\"item\":\"https://docs.swaps.xyz/prediction-market-reference/place-order-chain-abstracted\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Workflow Status\",\"item\":\"https://docs.swaps.xyz/prediction-market-reference/get-workflow-status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.swaps.xyz/prediction-market-reference/get-workflow-status#apireference\",\"headline\":\"Get Workflow Status\",\"name\":\"Get Workflow Status\",\"description\":\"Retrieves the status of a workflow transaction by transaction ID.\",\"url\":\"https://docs.swaps.xyz/prediction-market-reference/get-workflow-status\",\"mainEntityOfPage\":{\"@id\":\"https://docs.swaps.xyz/prediction-market-reference/get-workflow-status#webpage\"},\"dateModified\":\"2026-08-06T23:49:39.545Z\",\"publisher\":{\"@id\":\"https://docs.swaps.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.swaps.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Swaps API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Swaps API Documentation","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Swap API Reference","pages":[{"title":"Swap API Reference","href":"/swap-api-reference/overview"}]},{"tab":"Prediction Market Reference","groups":[{"group":"Getting Started","pages":[{"title":"Overview","href":"/prediction-market-reference/overview"},{"title":"Integration Patterns","href":"/prediction-market-reference/integration-patterns"},{"title":"Transaction Lifecycle","href":"/prediction-market-reference/transaction-lifecycle"},{"title":"Polymarket Signing Guide","href":"/prediction-market-reference/polymarket-signing"}]},{"group":"Trading","pages":[{"title":"Place Order (Chain Abstracted)","href":"/prediction-market-reference/place-order-chain-abstracted"},{"title":"Create or Fetch User","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json post /api/workflows/polymarket/createOrFetchPolymarketUser","href":"/prediction-market-reference/create-or-fetch-user"},{"title":"Place Order","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json post /api/workflows/polymarket/placeOrder","href":"/prediction-market-reference/place-order"},{"title":"Sell Position","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json post /api/workflows/polymarket/sellPosition","href":"/prediction-market-reference/sell-position"},{"title":"Redeem Position","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json post /api/workflows/polymarket/redeemPosition","href":"/prediction-market-reference/redeem-position"},{"title":"Merge Position","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json post /api/workflows/polymarket/mergePositions","href":"/prediction-market-reference/merge-position"},{"title":"Withdraw","description":"Withdraws the user's Polymarket proxy-wallet collateral to an arbitrary `dstWalletAddress`. Optional `dstToken` swaps the proxy collateral into a different token (and/or chain) before delivery.\n\nThis endpoint **always requires** an EIP-712 `signatureByEvmEoa` produced by the user's EOA over `{ dstToken, dstWalletAddress, expiration }` — see the [Polymarket Signing Guide](/prediction-market-reference/polymarket-signing). The signature is what authorizes funds being sent to a wallet other than the EOA.\n\nThe endpoint awaits successful execution of the withdrawal transaction before returning the transaction hash.","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json post /api/workflows/polymarket/withdraw","href":"/prediction-market-reference/withdraw"},{"title":"Get Workflow Status","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/getStatus","href":"/prediction-market-reference/get-workflow-status"}]},{"group":"Market Discovery","pages":[{"title":"Search Markets","description":"Search for markets and events by query string or tags.","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/polymarket/search","href":"/prediction-market-reference/search-markets"},{"title":"Get Trending Markets","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/polymarket/getTrendingMarkets","href":"/prediction-market-reference/get-trending-markets"},{"title":"Get Tags","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/polymarket/getTags","href":"/prediction-market-reference/get-tags"}]},{"group":"Market Information","pages":[{"title":"Get Event","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/polymarket/getEvent","href":"/prediction-market-reference/get-event"},{"title":"Get Markets","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/polymarket/getMarkets","href":"/prediction-market-reference/get-markets"},{"title":"Get Market Price","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/polymarket/getMarketPrice","href":"/prediction-market-reference/get-market-price"},{"title":"Get Price History","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/polymarket/getPriceHistory","href":"/prediction-market-reference/get-price-history"}]},{"group":"User Positions \u0026 Activity","pages":[{"title":"Get Current Positions","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/polymarket/getCurrentPositions","href":"/prediction-market-reference/get-current-positions"},{"title":"Get Closed Positions","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/polymarket/getClosedPositions","href":"/prediction-market-reference/get-closed-positions"},{"title":"Get Trades","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/polymarket/getTrades","href":"/prediction-market-reference/get-trades"},{"title":"Get Activity","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/polymarket/getActivity","href":"/prediction-market-reference/get-activity"},{"title":"Get Profit and Loss","deprecated":null,"version":null,"openapi":"/prediction-market-reference/openapi.json get /api/workflows/polymarket/getPnL","href":"/prediction-market-reference/get-profit-and-loss"}]}]},{"tab":"Protocol Reference","pages":[{"title":"Protocol Reference","href":"/protocol-reference/overview"}]}]},"basePath":"","title":"Get Workflow Status - Swaps API Documentation","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}