No Authentication RequiredThe health check endpoint is publicly accessible and does not require authentication. This allows monitoring systems to verify service availability without credentials.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Polymarket US Documentation","colors":{"primary":"#165DFC","light":"#165DFC","dark":"#165DFC"},"logo":{"light":"https://mintcdn.com/polymarketusdocs/NN49MNZwHafQdUcP/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=NN49MNZwHafQdUcP\u0026q=85\u0026s=31d6284cd801a07214abb060e79928e4","dark":"https://mintcdn.com/polymarketusdocs/NN49MNZwHafQdUcP/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=NN49MNZwHafQdUcP\u0026q=85\u0026s=5a708086de6cea6b0d2e06113cb3d890"},"favicon":"https://mintcdn.com/polymarketusdocs/evzbz56sXnnj2zm_/favicon.svg?fit=max\u0026auto=format\u0026n=evzbz56sXnnj2zm_\u0026q=85\u0026s=c10a861ca59caafabd100b8975cc0b5c","background":{"color":{"light":"#FFFFFF","dark":"#0A0B0D"}},"navbar":{"links":[{"icon":"signal","href":"https://status.polymarketexchange.com","label":"System Status"},{"icon":"discord","href":"https://discord.gg/cA6Skf5wCk","label":"Join Discord"}],"primary":{"type":"button","label":"Main Site","href":"https://polymarket.us"}},"footer":{"socials":{"x":"https://x.com/polymarket","linkedin":"https://www.linkedin.com/company/polymarket","discord":"https://discord.gg/cA6Skf5wCk"},"links":[{"header":"Polymarket","items":[{"label":"Careers","href":"https://polymarket.com/careers"},{"label":"Polymarket International","href":"https://polymarket.com"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://polymarket.us/privacy"},{"label":"Terms of Service","href":"https://polymarket.us/tos"},{"label":"Market Integrity","href":"https://integrity.polymarket.us/"},{"label":"System Status","href":"https://status.polymarketexchange.com"},{"label":"Polymarket Exchange","href":"https://polymarketexchange.com/"},{"label":"Polymarket Clearing","href":"https://polymarketclearing.com/"}]}]},"fonts":{"family":"Inter"},"styling":{"eyebrows":"breadcrumbs","latex":false},"banner":{"content":"You are viewing documentation for Polymarket US","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"polymarketusdocs","hasAudioNarration":false,"actualSubdomain":"polymarketusdocs","customDomains":["docs.polymarket.us"],"gitSource":{"type":"github","owner":"polymarket","repo":"website-isv-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4d6dce5865a4973d4139f","collectionId":"de8ac8a5-4d15-4172-a8dc-b32e3965d74d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4d6dce5865a4973d4139f"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae8f08d271fde1742ca9c70","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Institutional API","count":121},{"language":"default","tag":"API Reference","count":71},{"language":"default","tag":"REST API","count":64},{"language":"default","tag":"App Users","count":47},{"language":"default","tag":"RFQs","count":42},{"language":"default","tag":"Partner Integration","count":29},{"language":"default","tag":"Trading","count":28},{"language":"default","tag":"FIX API","count":23},{"language":"default","tag":"Guide","count":22},{"language":"default","tag":"SDKs","count":21}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"type":"link","url":"http://polymarket.us/support"}},"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":"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":"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":"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":"billing-updated-9-15","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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#content-container table{table-layout:auto}#content-container table td,#content-container table th{min-width:0!important}#content-container table td code,#content-container table td[data-numeric=true],#content-container table th code{white-space:nowrap}.rewards-cta .card{background:#165dfc!important;border-color:transparent!important}.rewards-cta .card:hover{background:#1253e0!important;border-color:transparent!important}.rewards-cta .card [data-component-part=card-title]{color:#fff!important}.rewards-cta .card [data-component-part=card-content]{color:rgb(255 255 255/.85)!important}.rewards-cta .card [data-component-part=card-icon] svg{background-color:#fff!important}.rewards-cta .card #card-link-arrow-icon{color:rgb(255 255 255/.8)!important}"}],"page":{"pagePath":"institutional/health/overview","slug":"/institutional/health/overview","pageMetadata":{"title":"Health API Overview","description":"Service health check endpoint","href":"/institutional/health/overview"},"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: \"Service health check endpoint\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Info,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`endpoints`,children:`Endpoints`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Method`}),_jsx(_components.th,{children:`Endpoint`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/health`})}),_jsx(_components.td,{children:`Check service health status`})]})})]}),`\n`,_jsxs(Info,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`No Authentication Required`})}),_jsx(_components.p,{children:`The health check endpoint is publicly accessible and does not require authentication. This allows monitoring systems to verify service availability without credentials.`})]}),`\n`,_jsx(Heading,{level:`2`,id:`when-to-use`,children:`When to Use`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Use Case`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Service Monitoring`})}),_jsx(_components.td,{children:`Check if the API is online and responding`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Pre-flight Checks`})}),_jsx(_components.td,{children:`Verify connectivity before starting trading operations`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Load Balancer Health Checks`})}),_jsx(_components.td,{children:`Configure external load balancers to monitor API availability`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Uptime Monitoring`})}),_jsx(_components.td,{children:`Set up automated alerts for service outages`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`response-format`,children:`Response Format`}),`\n`,_jsx(_components.p,{children:`The health check returns a simple JSON response indicating the service status:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ok\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`status`})}),_jsxs(_components.td,{children:[`Service status (`,_jsx(_components.code,{children:`ok`}),` when healthy)`]})]})})]}),`\n`,_jsx(Heading,{level:`2`,id:`example-usage`,children:`Example Usage`}),`\n`,_jsx(Heading,{level:`3`,id:`check-service-health`,children:`Check Service Health`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.preprod.polymarketexchange.com/v1/health`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`production-health-check`,children:`Production Health Check`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.prod.polymarketexchange.com/v1/health`})]}),`\n`]})})}),`\n`,_jsxs(Tip,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Quick Links`})}),_jsx(_components.p,{children:`Test the health endpoint for each environment:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`https://api.preprod.polymarketexchange.com/v1/health`,children:`Preprod Health Check`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`https://api.prod.polymarketexchange.com/v1/health`,children:`Production Health Check`})}),`\n`]})]}),`\n`,_jsx(Heading,{level:`2`,id:`integration-examples`,children:`Integration Examples`}),`\n`,_jsx(Heading,{level:`3`,id:`monitoring-script`,children:`Monitoring Script`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`19`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`19`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` time`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` check_health`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`base_url`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`):`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` try`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` response `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.get(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`base_url`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/v1/health\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`timeout`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`5`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` response.status_code `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`==`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 200`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` data `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` response.json()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"✓ Service is `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'status'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` True`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` else`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"✗ Unexpected status code: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`response.status_code`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` False`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` except`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` Exception`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` as`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` e:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"✗ Health check failed: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`e`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` False`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Check preprod environment`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`check_health(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://api.preprod.polymarketexchange.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`kubernetes-liveness-probe`,children:`Kubernetes Liveness Probe`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,language:`yaml`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`yaml`,children:_jsxs(_components.code,{language:`yaml`,numberOfLines:`9`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`livenessProbe`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` httpGet`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` path`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/v1/health`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` port`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`443`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` scheme`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`HTTPS`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` initialDelaySeconds`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`30`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` periodSeconds`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`10`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` timeoutSeconds`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`5`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` failureThreshold`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`3`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`docker-health-check`,children:`Docker Health Check`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`docker`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`docker`,children:_jsxs(_components.code,{language:`docker`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`HEALTHCHECK`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` --interval=30s --timeout=5s --start-period=30s --retries=3 \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` CMD`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` curl -f https://api.preprod.polymarketexchange.com/v1/health || exit 1`})]}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Health API Overview","description":"Service health check endpoint","href":"/institutional/health/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Endpoints","slug":"endpoints","depth":2,"children":[]},{"title":"When to Use","slug":"when-to-use","depth":2,"children":[]},{"title":"Response Format","slug":"response-format","depth":2,"children":[]},{"title":"Example Usage","slug":"example-usage","depth":2,"children":[{"title":"Check Service Health","slug":"check-service-health","depth":3,"children":[]},{"title":"Production Health Check","slug":"production-health-check","depth":3,"children":[]}]},{"title":"Integration Examples","slug":"integration-examples","depth":2,"children":[{"title":"Monitoring Script","slug":"monitoring-script","depth":3,"children":[]},{"title":"Kubernetes Liveness Probe","slug":"kubernetes-liveness-probe","depth":3,"children":[]},{"title":"Docker Health Check","slug":"docker-health-check","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"polymarketusdocs","siteName":"Polymarket US Documentation","title":"Health API Overview - Polymarket US Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-04T19:09:36.697Z","originalFileLocation":"institutional/health/overview.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=\"Service health check endpoint\">\u003cmeta data-mint-head name=\"application-name\" content=\"Polymarket US 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/polymarketusdocs/YN7ghhSTLd6PklJ-/_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/polymarketusdocs/YN7ghhSTLd6PklJ-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/polymarketusdocs/YN7ghhSTLd6PklJ-/_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/polymarketusdocs/YN7ghhSTLd6PklJ-/_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/polymarketusdocs/YN7ghhSTLd6PklJ-/_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/polymarketusdocs/YN7ghhSTLd6PklJ-/_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/polymarketusdocs/YN7ghhSTLd6PklJ-/_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/polymarketusdocs/YN7ghhSTLd6PklJ-/_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/polymarketusdocs/YN7ghhSTLd6PklJ-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Health API Overview - Polymarket US Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Service health check endpoint\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Polymarket US Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.polymarket.us/institutional/health/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://polymarketusdocs.mintlify.app/_mintlify/api/og/v2?division=Health\u0026amp;title=Health+API+Overview\u0026amp;description=Service+health+check+endpoint\u0026amp;theme=258f311544a75bb798e8b1d2\u0026amp;signature=cac93b4abc2154dd73dd14bc873fa474465249de033c03cc280b496ef7abed5e\">\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=\"Health API Overview - Polymarket US Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Service health check endpoint\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://polymarketusdocs.mintlify.app/_mintlify/api/og/v2?division=Health\u0026amp;title=Health+API+Overview\u0026amp;description=Service+health+check+endpoint\u0026amp;theme=258f311544a75bb798e8b1d2\u0026amp;signature=cac93b4abc2154dd73dd14bc873fa474465249de033c03cc280b496ef7abed5e\">\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/polymarketusdocs/YN7ghhSTLd6PklJ-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Polymarket US Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#165DFC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.polymarket.us/institutional/health/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/institutional/health/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.polymarket.us/#organization\",\"name\":\"Polymarket US Documentation\",\"url\":\"https://docs.polymarket.us\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/polymarketusdocs/NN49MNZwHafQdUcP/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=NN49MNZwHafQdUcP\u0026q=85\u0026s=31d6284cd801a07214abb060e79928e4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.polymarket.us#website\",\"name\":\"Polymarket US Documentation\",\"url\":\"https://docs.polymarket.us\",\"publisher\":{\"@id\":\"https://docs.polymarket.us/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.polymarket.us/institutional/health/overview#webpage\",\"url\":\"https://docs.polymarket.us/institutional/health/overview\",\"name\":\"Health API Overview\",\"description\":\"Service health check endpoint\",\"dateModified\":\"2026-09-04T19:09:36.697Z\",\"isPartOf\":{\"@id\":\"https://docs.polymarket.us#website\"},\"breadcrumb\":{\"@id\":\"https://docs.polymarket.us/institutional/health/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.polymarket.us/institutional/health/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Polymarket US Documentation\",\"item\":\"https://docs.polymarket.us\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Health API Overview\",\"item\":\"https://docs.polymarket.us/institutional/health/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.polymarket.us/institutional/health/overview#article\",\"headline\":\"Health API Overview\",\"name\":\"Health API Overview\",\"description\":\"Service health check endpoint\",\"url\":\"https://docs.polymarket.us/institutional/health/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.polymarket.us/institutional/health/overview#webpage\"},\"dateModified\":\"2026-09-04T19:09:36.697Z\",\"publisher\":{\"@id\":\"https://docs.polymarket.us/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.polymarket.us#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Polymarket US Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Polymarket US Documentation","nav":{"global":{},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/getting-started/welcome"}]},{"tab":"App Users","pages":[{"title":"App Users","href":"/learn/home"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"tab":"WebSockets","pages":[{"title":"WebSockets","href":"/api-reference/websocket/overview"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/api-reference/sdks/introduction"}]},{"tab":"Institutional API","anchors":[{"anchor":"Guide","pages":[{"title":"Guide","href":"/trader-guide/overview"}]},{"anchor":"REST API","groups":[{"group":"Overview","pages":[{"title":"REST API Overview","description":"Complete guide to the Polymarket US REST API","href":"/institutional/introduction"}]},{"group":"Health","pages":[{"title":"Health API Overview","href":"/institutional/health/overview"},{"group":"Health","pages":[{"title":"Health check","description":"Check service health status","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/health-schema.json get /v1/health","href":"/api-reference/health/health-check"}]}]},{"group":"Trading","pages":[{"title":"Trading API Overview","href":"/institutional/trading/overview"},{"group":"Trading","pages":[{"title":"Insert order","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders","href":"/api-reference/trading/insert-order"},{"title":"Cancel order","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders/cancel","href":"/api-reference/trading/cancel-order"},{"title":"Cancel order list","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders/cancel/list","href":"/api-reference/trading/cancel-order-list"},{"title":"Insert order cross","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders/cross","href":"/api-reference/trading/insert-order-cross"},{"title":"Insert order list","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders/list","href":"/api-reference/trading/insert-order-list"},{"title":"Get open orders","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json get /v1/trading/orders/open","href":"/api-reference/trading/get-open-orders"},{"title":"Preview order","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders/preview","href":"/api-reference/trading/preview-order"},{"title":"Cancel replace order","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders/replace","href":"/api-reference/trading/cancel-replace-order"},{"title":"Cancel replace order list","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/trading-schema.json post /v1/trading/orders/replace/list","href":"/api-reference/trading/cancel-replace-order-list"}]}]},{"group":"Combos","pages":[{"title":"Combos API Overview","href":"/institutional/combos/overview"},{"group":"Combos","pages":[{"title":"Get combos","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/combos-schema.json get /v1/combos","href":"/api-reference/combos/get-combos"},{"title":"Create combo","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/combos-schema.json post /v1/combos","href":"/api-reference/combos/create-combo"}]}]},{"group":"RFQs","pages":[{"title":"RFQ API Overview","href":"/institutional/rfqs/overview"},{"group":"RFQs","pages":[{"title":"Get RFQs","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json get /v1/rfqs","href":"/institutional/rfqs/get-rfqs"},{"title":"Create RFQ","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json post /v1/rfqs","href":"/institutional/rfqs/create-rfq"},{"title":"Get quotes","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json get /v1/rfqs/quotes","href":"/institutional/rfqs/get-quotes"},{"title":"Create quote","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json post /v1/rfqs/quotes","href":"/institutional/rfqs/create-quote"},{"title":"Get RFQ trades","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json get /v1/rfqs/trades","href":"/institutional/rfqs/get-rfq-trades"},{"title":"Get RFQ user ID","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json get /v1/rfqs/user-id","href":"/institutional/rfqs/get-rfq-user-id"},{"title":"Delete RFQ","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json delete /v1/rfqs/{rfqId}","href":"/institutional/rfqs/delete-rfq"},{"title":"Delete quote","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json delete /v1/rfqs/{rfqId}/quotes/{quoteId}","href":"/institutional/rfqs/delete-quote"},{"title":"Accept quote","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json put /v1/rfqs/{rfqId}/quotes/{quoteId}/accept","href":"/institutional/rfqs/accept-quote"},{"title":"Confirm quote","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/rfqs-schema.json put /v1/rfqs/{rfqId}/quotes/{quoteId}/confirm","href":"/institutional/rfqs/confirm-quote"}]}]},{"group":"Report","pages":[{"title":"Report API Overview","href":"/institutional/report/overview"},{"group":"Report","pages":[{"title":"Download executions CSV","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/report-schema.json post /v1/report/executions/csv","href":"/api-reference/report/download-executions-csv"},{"title":"Search executions","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/report-schema.json post /v1/report/executions/search","href":"/api-reference/report/search-executions"},{"title":"Download orders CSV","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/report-schema.json post /v1/report/orders/csv","href":"/api-reference/report/download-orders-csv"},{"title":"Search orders","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/report-schema.json post /v1/report/orders/search","href":"/api-reference/report/search-orders"},{"title":"Download trades CSV","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/report-schema.json post /v1/report/trades/csv","href":"/api-reference/report/download-trades-csv"},{"title":"Search trades","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/report-schema.json post /v1/report/trades/search","href":"/api-reference/report/search-trades"},{"title":"Get trade stats","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/report-schema.json post /v1/report/trades/stats","href":"/api-reference/report/get-trade-stats"}]}]},{"group":"Positions","pages":[{"title":"Positions API Overview","href":"/institutional/positions/overview"},{"group":"Positions","pages":[{"title":"List account positions","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/positions-schema.json get /v1/positions","href":"/api-reference/positions/list-account-positions"},{"title":"Get account balance","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/positions-schema.json post /v1/positions/balance","href":"/api-reference/positions/get-account-balance"},{"title":"List account balances","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/positions-schema.json post /v1/positions/balances","href":"/api-reference/positions/list-account-balances"},{"title":"Get position ledger","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/positions-schema.json get /v1/positions/ledger","href":"/api-reference/positions/get-position-ledger"},{"title":"Download position ledger as CSV","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/positions-schema.json get /v1/positions/ledger/download","href":"/api-reference/positions/download-position-ledger-as-csv"}]}]},{"group":"Funding","pages":[{"title":"Funding Overview","href":"/institutional/funding/overview"},{"group":"Funding","pages":[{"title":"Get account balance ledger","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/funding-schema.json get /v1/funding/balance-ledger","href":"/api-reference/funding/get-account-balance-ledger"},{"title":"Download account balance ledger as CSV","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/funding-schema.json get /v1/funding/balance-ledger/download","href":"/api-reference/funding/download-account-balance-ledger-as-csv"}]}]},{"group":"Order Book","pages":[{"title":"Order Book API Overview","href":"/institutional/orderbook/overview"},{"group":"Order Book","pages":[{"title":"Get order book","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/orderbook-schema.json get /v1/orderbook/{symbol}","href":"/api-reference/order-book/get-order-book"},{"title":"Get best bid/offer","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/orderbook-schema.json get /v1/orderbook/{symbol}/bbo","href":"/api-reference/order-book/get-best-bidoffer"}]}]},{"group":"Settlement","pages":[{"title":"Settlement API Overview","href":"/institutional/settlement/overview"},{"group":"Settlement","pages":[{"title":"Get instrument settlement","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/settlement-schema.json get /v1/instruments/{symbol}/settlement","href":"/api-reference/settlement/get-instrument-settlement"}]}]},{"group":"Reference Data","pages":[{"title":"Reference Data API Overview","href":"/institutional/refdata/overview"},{"group":"ReferenceData","pages":[{"title":"List instruments","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/refdata-schema.json post /v1/refdata/instruments","href":"/api-reference/referencedata/list-instruments"},{"title":"Get instrument metadata","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/refdata-schema.json post /v1/refdata/metadata","href":"/api-reference/referencedata/get-instrument-metadata"},{"title":"List symbols","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/refdata-schema.json post /v1/refdata/symbols","href":"/api-reference/referencedata/list-symbols"}]}]},{"group":"Accounts","pages":[{"title":"Accounts API Overview","href":"/institutional/accounts/overview"},{"group":"Accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/accounts-schema.json get /v1/accounts","href":"/api-reference/accounts/list-accounts"},{"title":"List users","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/accounts-schema.json get /v1/users","href":"/api-reference/accounts/list-users"},{"title":"Get who am I","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/accounts-schema.json get /v1/whoami","href":"/api-reference/accounts/get-who-am-i"}]}]},{"group":"Payments","pages":[{"title":"Payments Overview","href":"/institutional/payments/overview"},{"title":"Aeropay Integration","href":"/institutional/payments/aeropay-guide"},{"title":"Checkout Integration","href":"/institutional/payments/checkout-guide"},{"title":"Funding Management","href":"/institutional/payments/funding-management"}]},{"group":"Incentives","pages":[{"title":"Incentives API Overview","href":"/institutional/incentives/overview"},{"group":"Incentives","pages":[{"title":"Get Incentive Programs","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/incentives-schema.json get /v1/incentives","href":"/api-reference/incentives/get-incentive-programs"},{"title":"Get Incentive Earnings","deprecated":null,"version":null,"openapi":"/institutional/oapi-schemas/incentives-schema.json get /v1/incentives/earnings","href":"/api-reference/incentives/get-incentive-earnings"}]}]}]},{"anchor":"gRPC API","pages":[{"title":"gRPC API","href":"/grpc-api/overview"}]},{"anchor":"FIX API","pages":[{"title":"FIX API","href":"/institutional/fix-api/fix-overview"}]}]},{"tab":"Incentives","pages":[{"title":"Incentives","href":"/incentives/overview"}]},{"tab":"Fees \u0026 Rebates","pages":[{"title":"Fees \u0026 Rebates","href":"/fees"}]},{"tab":"Data","pages":[{"title":"Data","href":"/data-guide/overview"}]},{"tab":"Partner Integration","pages":[{"title":"Partner Integration","href":"/partners/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Health API Overview - Polymarket US Documentation","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":[],"chunks":[]}