Runnable @ostium/builder-sdk programs shipped with the package: an order ticket, a live positions view, and a complete trade loop.
Three runnable programs ship with the package, at node_modules/@ostium/builder-sdk/examples/ after install. They import the SDK by package name, so they also run unchanged if you copy them into your own project.
File
What it shows
Needs a key?
order-ticket.ts
Preview a trade the way an order ticket would — execution price, fees, liquidation price, validity
No
positions.ts
A trader’s open positions, then live PnL over WebSocket
Snapshot no; streaming needs a WebSocket RPC
bot.ts
A complete trade loop: onboard, preview, submit, watch, close
bun node_modules/@ostium/builder-sdk/examples/order-ticket.tsbun node_modules/@ostium/builder-sdk/examples/positions.ts 0xTraderAddressARBITRUM_WS_URL=wss://... \ bun node_modules/@ostium/builder-sdk/examples/positions.ts 0xTraderAddressPRIVATE_KEY=0x... ARBITRUM_RPC_URL=https://... \ bun node_modules/@ostium/builder-sdk/examples/bot.ts
They are TypeScript — run them with bun, or compile them with tsc first.
Resolves BTC/USD from getPairs(), then prints what previewOpenTrade() returns: execution price, fees, liquidation price and any warnings. Read-only — no key, nothing submitted.
Prints a trader’s open positions from getOpenPositions(), then streams live updates via streamAccountUpdates().The snapshot needs no credentials. Streaming needs a WebSocket Arbitrum RPC endpoint; without one the example prints the snapshot and skips streaming. ALCHEMY_API_KEY also works.
The full lifecycle: getOnboardingStatus(), previewOpenTrade(), openTrade(), watching the position, then closeTrade() — including how to handle OstiumError and OstiumSubmissionPendingError.
bot.ts spends funds. It defaults to testnet; MAINNET=1 points it at real money.
The package also ships llms.txt and a Claude skill at .claude/skills/ostium-builder-sdk/SKILL.md — flat API references written for coding agents. Point your agent at one of them instead of pasting documentation pages.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ostium","colors":{"primary":"#FF5A19","light":"#FF5A19","dark":"#FF5A19"},"logo":"https://mintcdn.com/ostium/rgKhfmKxgkO9O2aD/logo/ostium-logo.svg?fit=max\u0026auto=format\u0026n=rgKhfmKxgkO9O2aD\u0026q=85\u0026s=e2316b63df8fab1bbdb3c18daeff80e5","favicon":"https://mintcdn.com/ostium/PYRmOzvp-N2ht7oL/favicon.svg?fit=max\u0026auto=format\u0026n=PYRmOzvp-N2ht7oL\u0026q=85\u0026s=79bfadbe417502d9aec3c62a2a59d62e","navbar":{"links":[{"href":"https://discord.com/invite/ostiumlabs","label":"Support"}],"primary":{"type":"button","label":"Trade Now","href":"https://app.ostium.com"}},"footer":{"socials":{"x":"https://x.com/Ostium","github":"https://github.com/ostium-labs","linkedin":"https://linkedin.com/company/ostium"},"links":[{"header":"Legal","items":[{"label":"Terms of Use","href":"/legal/terms-of-use"},{"label":"Privacy Policy","href":"/legal/privacy-policy"},{"label":"Nasdaq Subscriber Agreement","href":"/legal/nasdaq-subscriber-agreement"},{"label":"OLP Recovery Plan Terms","href":"/legal/olp-recovery-plan-terms"}]}]},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://ostium.com"},{"anchor":"Developers","icon":"code","href":"/developer/sdk/overview"},{"anchor":"Blog","icon":"newspaper","href":"https://www.ostium.com/blog"},{"anchor":"X/Twitter","icon":"twitter","href":"https://www.x.com/Ostium"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ostium","hasAudioNarration":false,"actualSubdomain":"ostium","customDomains":["docs.ostium.com"],"gitSource":{"type":"github","owner":"0xostium","repo":"new-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae8adde3630049289ff569a","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Developers","count":63},{"language":"default","tag":"Read Methods","count":17},{"language":"default","tag":"API Reference","count":16},{"language":"default","tag":"Traders","count":13},{"language":"default","tag":"Helpers","count":10},{"language":"default","tag":"Client Modes","count":8},{"language":"default","tag":"Builder API","count":7},{"language":"default","tag":"Trading","count":6},{"language":"default","tag":"Write Methods","count":5},{"language":"default","tag":"Previews \u0026 Limits","count":5}]},"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":"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":"editor-metadata","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},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"developer/sdk/examples","slug":"/developer/sdk/examples","pageMetadata":{"title":"Examples","description":"Runnable @ostium/builder-sdk programs shipped with the package: an order ticket, a live positions view, and a complete trade loop.","href":"/developer/sdk/examples"},"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: \"Runnable @ostium/builder-sdk programs shipped with the package: an order ticket, a live positions view, and a complete trade loop.\"\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`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Three runnable programs ship with the package, at `,_jsx(_components.code,{children:`node_modules/@ostium/builder-sdk/examples/`}),` after install. They import the SDK by package name, so they also run unchanged if you copy them into your own project.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`File`}),_jsx(_components.th,{children:`What it shows`}),_jsx(_components.th,{children:`Needs a key?`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`order-ticket.ts`})}),_jsx(_components.td,{children:`Preview a trade the way an order ticket would — execution price, fees, liquidation price, validity`}),_jsx(_components.td,{children:`No`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`positions.ts`})}),_jsx(_components.td,{children:`A trader’s open positions, then live PnL over WebSocket`}),_jsx(_components.td,{children:`Snapshot no; streaming needs a WebSocket RPC`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`bot.ts`})}),_jsx(_components.td,{children:`A complete trade loop: onboard, preview, submit, watch, close`}),_jsx(_components.td,{children:`Yes`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`running-them`,children:`Running them`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,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:`9`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`bun`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` node_modules/@ostium/builder-sdk/examples/order-ticket.ts`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`bun`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` node_modules/@ostium/builder-sdk/examples/positions.ts`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 0xTraderAddress`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`ARBITRUM_WS_URL`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`wss://...`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` bun`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` node_modules/@ostium/builder-sdk/examples/positions.ts`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 0xTraderAddress`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`PRIVATE_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`0x...`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ARBITRUM_RPC_URL`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`https://...`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` bun`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` node_modules/@ostium/builder-sdk/examples/bot.ts`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`They are TypeScript — run them with `,_jsx(_components.code,{children:`bun`}),`, or compile them with `,_jsx(_components.code,{children:`tsc`}),` first.`]}),`\n`,_jsx(Heading,{level:`2`,id:`order-ticket-ts`,children:`order-ticket.ts`}),`\n`,_jsxs(_components.p,{children:[`Resolves BTC/USD from `,_jsx(_components.a,{href:`/developer/reference/get-pairs`,children:_jsx(_components.code,{children:`getPairs()`})}),`, then prints what `,_jsx(_components.a,{href:`/developer/reference/preview-open-trade`,children:_jsx(_components.code,{children:`previewOpenTrade()`})}),` returns: execution price, fees, liquidation price and any warnings. Read-only — no key, nothing submitted.`]}),`\n`,_jsx(Heading,{level:`2`,id:`positions-ts`,children:`positions.ts`}),`\n`,_jsxs(_components.p,{children:[`Prints a trader’s open positions from `,_jsx(_components.a,{href:`/developer/reference/get-open-positions`,children:_jsx(_components.code,{children:`getOpenPositions()`})}),`, then streams live updates via `,_jsx(_components.a,{href:`/developer/reference/stream-account-updates`,children:_jsx(_components.code,{children:`streamAccountUpdates()`})}),`.`]}),`\n`,_jsxs(_components.p,{children:[`The snapshot needs no credentials. Streaming needs a WebSocket Arbitrum RPC endpoint; without one the example prints the snapshot and skips streaming. `,_jsx(_components.code,{children:`ALCHEMY_API_KEY`}),` also works.`]}),`\n`,_jsx(Heading,{level:`2`,id:`bot-ts`,children:`bot.ts`}),`\n`,_jsxs(_components.p,{children:[`The full lifecycle: `,_jsx(_components.a,{href:`/developer/reference/get-onboarding-status`,children:_jsx(_components.code,{children:`getOnboardingStatus()`})}),`, `,_jsx(_components.a,{href:`/developer/reference/preview-open-trade`,children:_jsx(_components.code,{children:`previewOpenTrade()`})}),`, `,_jsx(_components.code,{children:`openTrade()`}),`, watching the position, then `,_jsx(_components.code,{children:`closeTrade()`}),` — including how to handle `,_jsx(_components.code,{children:`OstiumError`}),` and `,_jsx(_components.code,{children:`OstiumSubmissionPendingError`}),`.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`bot.ts`}),` spends funds. It defaults to testnet; `,_jsx(_components.code,{children:`MAINNET=1`}),` points it at real money.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`for-ai-coding-agents`,children:`For AI coding agents`}),`\n`,_jsxs(_components.p,{children:[`The package also ships `,_jsx(_components.code,{children:`llms.txt`}),` and a Claude skill at `,_jsx(_components.code,{children:`.claude/skills/ostium-builder-sdk/SKILL.md`}),` — flat API references written for coding agents. Point your agent at one of them instead of pasting documentation pages.`]})]})}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":"Examples","description":"Runnable @ostium/builder-sdk programs shipped with the package: an order ticket, a live positions view, and a complete trade loop.","href":"/developer/sdk/examples"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Running them","slug":"running-them","depth":2,"children":[]},{"title":"order-ticket.ts","slug":"order-ticket-ts","depth":2,"children":[]},{"title":"positions.ts","slug":"positions-ts","depth":2,"children":[]},{"title":"bot.ts","slug":"bot-ts","depth":2,"children":[]},{"title":"For AI coding agents","slug":"for-ai-coding-agents","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"ostium","siteName":"Ostium","title":"Examples - Ostium","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-23T09:28:47.266Z","originalFileLocation":"developer/sdk/examples.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=\"Runnable @ostium/builder-sdk programs shipped with the package: an order ticket, a live positions view, and a complete trade loop.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ostium\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ostium/YrHQiGdYpiT2HO80/_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/ostium/YrHQiGdYpiT2HO80/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ostium/YrHQiGdYpiT2HO80/_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/ostium/YrHQiGdYpiT2HO80/_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/ostium/YrHQiGdYpiT2HO80/_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/ostium/YrHQiGdYpiT2HO80/_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/ostium/YrHQiGdYpiT2HO80/_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/ostium/YrHQiGdYpiT2HO80/_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/ostium/YrHQiGdYpiT2HO80/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Examples - Ostium\">\u003cmeta data-mint-head property=\"og:description\" content=\"Runnable @ostium/builder-sdk programs shipped with the package: an order ticket, a live positions view, and a complete trade loop.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ostium\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ostium.com/developer/sdk/examples\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ostium.mintlify.site/_mintlify/api/og/v2?division=SDK\u0026amp;title=Examples\u0026amp;description=Runnable+%40ostium%2Fbuilder-sdk+programs+shipped+with+the+package%3A+an+order+ticket%2C+a+live+positions+view%2C+and+a+complete+trade+loop.\u0026amp;theme=4c59edf2484b017f3ed2d875\u0026amp;signature=cf44345629eb00f81b17e0e19d94ce7c9be9dd1ae5e25b84da6bc3b0ba9cc29d\">\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=\"Examples - Ostium\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Runnable @ostium/builder-sdk programs shipped with the package: an order ticket, a live positions view, and a complete trade loop.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ostium.mintlify.site/_mintlify/api/og/v2?division=SDK\u0026amp;title=Examples\u0026amp;description=Runnable+%40ostium%2Fbuilder-sdk+programs+shipped+with+the+package%3A+an+order+ticket%2C+a+live+positions+view%2C+and+a+complete+trade+loop.\u0026amp;theme=4c59edf2484b017f3ed2d875\u0026amp;signature=cf44345629eb00f81b17e0e19d94ce7c9be9dd1ae5e25b84da6bc3b0ba9cc29d\">\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/ostium/YrHQiGdYpiT2HO80/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ostium\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5A19\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ostium.com/developer/sdk/examples\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developer/sdk/examples.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ostium.com/#organization\",\"name\":\"Ostium\",\"url\":\"https://docs.ostium.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ostium/rgKhfmKxgkO9O2aD/logo/ostium-logo.svg?fit=max\u0026auto=format\u0026n=rgKhfmKxgkO9O2aD\u0026q=85\u0026s=e2316b63df8fab1bbdb3c18daeff80e5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ostium.com#website\",\"name\":\"Ostium\",\"url\":\"https://docs.ostium.com\",\"publisher\":{\"@id\":\"https://docs.ostium.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ostium.com/developer/sdk/examples#webpage\",\"url\":\"https://docs.ostium.com/developer/sdk/examples\",\"name\":\"Examples\",\"description\":\"Runnable @ostium/builder-sdk programs shipped with the package: an order ticket, a live positions view, and a complete trade loop.\",\"dateModified\":\"2026-09-23T09:28:47.266Z\",\"isPartOf\":{\"@id\":\"https://docs.ostium.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ostium.com/developer/sdk/examples#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ostium.com/developer/sdk/examples#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"SDK\",\"item\":\"https://docs.ostium.com/developer/sdk/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Examples\",\"item\":\"https://docs.ostium.com/developer/sdk/examples\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.ostium.com/developer/sdk/examples#article\",\"headline\":\"Examples\",\"name\":\"Examples\",\"description\":\"Runnable @ostium/builder-sdk programs shipped with the package: an order ticket, a live positions view, and a complete trade loop.\",\"url\":\"https://docs.ostium.com/developer/sdk/examples\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ostium.com/developer/sdk/examples#webpage\"},\"dateModified\":\"2026-09-23T09:28:47.266Z\",\"publisher\":{\"@id\":\"https://docs.ostium.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ostium.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ostium\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ostium","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://ostium.com"},{"anchor":"Developers","icon":"code","href":"/developer/sdk/overview"},{"anchor":"Blog","icon":"newspaper","href":"https://www.ostium.com/blog"},{"anchor":"X/Twitter","icon":"twitter","href":"https://www.x.com/Ostium"}]},"tabs":[{"tab":"Traders","pages":[{"title":"Traders","href":"/traders/welcome"}]},{"tab":"Vault","pages":[{"title":"Vault","href":"/vault/overview"}]},{"tab":"Protocol","pages":[{"title":"Protocol","href":"/protocol/how-ostium-works"}]},{"tab":"Developers","groups":[{"group":"SDK","pages":[{"title":"Ostium API \u0026 SDK","sidebarTitle":"SDK Overview","description":"The official Ostium TypeScript SDK and Builder API for reading market data, streaming prices, and placing trades programmatically on Ostium.","href":"/developer/sdk/overview"},{"title":"Examples","href":"/developer/sdk/examples"},{"title":"Errors","description":"Reference for Ostium SDK error classes and error codes.","href":"/developer/sdk/errors"},{"title":"Changelog","href":"/developer/sdk/changelog"}]},{"group":"Client Modes","pages":[{"title":"Client Modes","href":"/developer/client-modes/overview"},{"title":"Client Configuration","href":"/developer/client-modes/configuration"},{"title":"Self + Self","href":"/developer/client-modes/self-and-self"},{"title":"Self + Gasless","href":"/developer/client-modes/self-and-gasless"},{"title":"Delegated + Self","href":"/developer/client-modes/delegated-and-self"},{"title":"Delegated + Gasless","href":"/developer/client-modes/delegated-and-gasless"},{"title":"Read-only","href":"/developer/client-modes/read-only"},{"title":"Testnet","href":"/developer/client-modes/testnet"}]},{"group":"Helpers","pages":[{"title":"transaction builders","href":"/developer/reference/transaction-builders"},{"title":"getTraderAddress","href":"/developer/reference/get-trader-address"},{"title":"isReadOnly","href":"/developer/reference/is-read-only"},{"title":"getSmartAccountAddress","href":"/developer/reference/get-smart-account-address"},{"title":"checkUsdcAllowance","href":"/developer/reference/check-usdc-allowance"},{"title":"getBalances","href":"/developer/reference/get-balances"},{"title":"approveUsdc","href":"/developer/reference/approve-usdc"},{"title":"setupGaslessDelegation","href":"/developer/reference/setup-gasless-delegation"},{"title":"setDelegate","href":"/developer/reference/set-delegate"},{"title":"removeDelegate","href":"/developer/reference/remove-delegate"}]},{"group":"Previews \u0026 Limits","pages":[{"title":"previewOpenTrade","href":"/developer/reference/preview-open-trade"},{"title":"previewCloseTrade","href":"/developer/reference/preview-close-trade"},{"title":"getMaxCollateral","href":"/developer/reference/get-max-collateral"},{"title":"getOnboardingStatus","href":"/developer/reference/get-onboarding-status"},{"title":"getVaultBalance","href":"/developer/reference/get-vault-balance"}]},{"group":"Read Methods","pages":[{"title":"getPairs","href":"/developer/reference/get-pairs"},{"title":"getAllPrices","href":"/developer/reference/get-all-prices"},{"title":"getOpenPositions","href":"/developer/reference/get-open-positions"},{"title":"getOpenOrders","href":"/developer/reference/get-open-orders"},{"title":"getLimitOrderHistory","href":"/developer/reference/get-limit-order-history"},{"title":"getOrders","href":"/developer/reference/get-orders"},{"title":"getBuilderOrders","href":"/developer/reference/get-builder-orders"},{"title":"getFills","href":"/developer/reference/get-fills"},{"title":"getFillsByTime","href":"/developer/reference/get-fills-by-time"},{"title":"getSimSlippage","href":"/developer/reference/get-sim-slippage"},{"title":"getSimOrderbook","href":"/developer/reference/get-sim-orderbook"},{"title":"getCandles","href":"/developer/reference/get-candles"},{"title":"getPriceChanges24h","href":"/developer/reference/get-price-changes-24h"},{"title":"getRolloverHistory","href":"/developer/reference/get-rollover-history"},{"title":"streamPrices","href":"/developer/reference/stream-prices"},{"title":"streamPositionUpdates","href":"/developer/reference/stream-position-updates"},{"title":"streamAccountUpdates","href":"/developer/reference/stream-account-updates"}]},{"group":"Live State","pages":[{"title":"createStore","href":"/developer/reference/create-store"},{"title":"Math helpers","href":"/developer/reference/math-helpers"}]},{"group":"Write Methods","pages":[{"title":"openTrade","href":"/developer/reference/open-trade"},{"title":"closeTrade","href":"/developer/reference/close-trade"},{"title":"modifyOrder","href":"/developer/reference/modify-order"},{"title":"updateCollateral","href":"/developer/reference/update-collateral"},{"title":"cancelOrder","href":"/developer/reference/cancel-order"}]},{"group":"Builder API","pages":[{"title":"Builder API Overview","href":"/developer/builder-api/overview"},{"title":"GET /v1/prices","href":"/developer/builder-api/get-prices"},{"title":"POST /v1/ohlc","href":"/developer/builder-api/post-ohlc"},{"title":"WS /v1/prices/stream","href":"/developer/builder-api/ws-prices-stream"},{"title":"POST /v1/trade","href":"/developer/builder-api/post-trade"},{"title":"/v1/subgraph/gn","href":"/developer/builder-api/subgraph"},{"title":"POST /v1/pimlico/sponsor","href":"/developer/builder-api/pimlico-sponsor"}]},{"group":"Builder","pages":[{"title":"Builder Set Up","href":"/developer/builders/overview"},{"title":"Getting keys from the App","href":"/developer/builders/getting-keys-from-the-app"},{"title":"React Example","href":"/developer/builders/react-quickstart"}]},{"group":"Trader","pages":[{"title":"Traders Overview","href":"/developer/traders/overview"},{"title":"Trader Quickstart","href":"/developer/traders/approvals-and-first-trade"}]},{"group":"Legacy","pages":[{"title":"Legacy Developer Docs","href":"/developer/legacy/overview"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/overview"}]}]},"basePath":"","title":"Examples - Ostium","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":[],"chunks":[]}
