A bid cannot move between tranches — they have separate books, sizes and eligibility, so
moving is a withdrawal and a fresh bid rather than an edit. The field is not accepted here.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"GetEquity","colors":{"primary":"#3d70fd","light":"#0d70fd","dark":"#3d70fd"},"logo":{"light":"https://mintcdn.com/getequity-9353cd69/vgtVmrBA2jLoPm-V/logo/Light-001.png?fit=max\u0026auto=format\u0026n=vgtVmrBA2jLoPm-V\u0026q=85\u0026s=515177515afb51f52b712858383b6be7","dark":"https://mintcdn.com/getequity-9353cd69/vgtVmrBA2jLoPm-V/logo/Light-001.png?fit=max\u0026auto=format\u0026n=vgtVmrBA2jLoPm-V\u0026q=85\u0026s=515177515afb51f52b712858383b6be7"},"favicon":"https://mintcdn.com/getequity-9353cd69/vgtVmrBA2jLoPm-V/favicon.png?fit=max\u0026auto=format\u0026n=vgtVmrBA2jLoPm-V\u0026q=85\u0026s=3246cacbdc90efd5ddb5dcf35616880c","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://ge-exchange-staging-1.herokuapp.com/v1/"}},"navbar":{"links":[{"href":"https://business.getequity.io/onboarding/signin","label":"Login"}],"primary":{"type":"button","label":"Create an account","href":"https://business.getequity.io/onboarding/data-collection/api-client"}},"footer":{"socials":{"twitter":"https://twitter.com/getequity","facebook":"https://www.facebook.com/getequityHQ?_rdc=1\u0026_rdr","linkedin":"https://www.linkedin.com/company/getequity","instagram":"https://www.instagram.com/getequity_hq"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"getequity-9353cd69","hasAudioNarration":false,"actualSubdomain":"getequity-9353cd69","customDomains":["getequity.io"],"gitSource":{"type":"github","owner":"getequity","repo":"api-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6ad75bfed2b37be58192c95a","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":76},{"language":"default","tag":"Investments API · Direct","count":34},{"language":"default","tag":"Investments API · Managed","count":17},{"language":"default","tag":"Members","count":16},{"language":"default","tag":"Trade","count":15},{"language":"default","tag":"Webhook","count":15},{"language":"default","tag":"Events","count":14},{"language":"default","tag":"On-Chain","count":14},{"language":"default","tag":"Credit API","count":8},{"language":"default","tag":"Wallet","count":6}]},"assistantConfig":{},"basePath":"/docs","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":"api-reference/endpoint/Trade/amend-commitment","slug":"/api-reference/endpoint/Trade/amend-commitment","pageMetadata":{"title":"Amend a bid","api":"PATCH api/commitment/{commitmentId}","description":"Change the amount or limit on a live bid","href":"/api-reference/endpoint/Trade/amend-commitment"},"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: \"Change the amount or limit on a live bid\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{ParamField,Warning}=_components;if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Changes a live bid and adjusts the funds held to match. Send at least one field. The same\nbounds apply as when the bid was placed.`}),`\n`,_jsx(ParamField,{path:`commitmentId`,type:`string`,required:true,id:`param-commitment-id`,children:_jsx(_components.p,{children:`The id of the commitment.`})}),`\n`,_jsx(ParamField,{body:`amount`,type:`number`,id:`param-amount`,children:`The new amount.`}),`\n`,_jsxs(ParamField,{body:`bid_price`,type:`number`,id:`param-bid-price`,children:[`The new price limit. Mutually exclusive with `,_jsx(_components.code,{children:`bid_rate`}),`.`]}),`\n`,_jsxs(ParamField,{body:`bid_rate`,type:`number`,id:`param-bid-rate`,children:[`The new rate limit. Mutually exclusive with `,_jsx(_components.code,{children:`bid_price`}),`.`]}),`\n`,_jsx(ParamField,{body:`is_strike_bid`,type:`boolean`,id:`param-is-strike-bid`,children:`Convert to a strike bid, where allowed.`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`A bid `,_jsx(_components.strong,{children:`cannot move between tranches`}),` — they have separate books, sizes and eligibility, so\nmoving is a withdrawal and a fresh bid rather than an edit. The field is not accepted here.`]})})]})}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":"Amend a bid","api":"PATCH api/commitment/{commitmentId}","description":"Change the amount or limit on a live bid","href":"/api-reference/endpoint/Trade/amend-commitment"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{},"endpoint":{"title":"Amend a bid","path":"api/commitment/{commitmentId}","servers":[{"url":"https://ge-exchange-staging-1.herokuapp.com/v1/"}],"method":"patch","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{"commitmentId":{"schema":[{"type":"string","description":"The id of the commitment.","required":true}]}}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"amount":[{"type":"number","description":"The new amount."}],"bid_price":[{"type":"number","description":"The new price limit. Mutually exclusive with `bid_rate` ."}],"bid_rate":[{"type":"number","description":"The new rate limit. Mutually exclusive with `bid_price` ."}],"is_strike_bid":[{"type":"boolean","description":"Convert to a strike bid, where allowed."}]}}],"examples":{"example":{"value":{"amount":123,"bid_price":123,"bid_rate":123,"is_strike_bid":true}}}}}},"response":{},"deprecated":false}},"jsLinks":[],"subdomain":"getequity-9353cd69","siteName":"GetEquity","title":"Amend a bid - GetEquity","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-29T18:41:03.082Z","originalFileLocation":"api-reference/endpoint/Trade/amend-commitment.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=\"Change the amount or limit on a live bid\">\u003cmeta data-mint-head name=\"application-name\" content=\"GetEquity\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/getequity-9353cd69/FVKdWr089E4fvxo8/_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=\"/docs/mintlify-assets/_mintlify/favicons/getequity-9353cd69/FVKdWr089E4fvxo8/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/getequity-9353cd69/FVKdWr089E4fvxo8/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/getequity-9353cd69/FVKdWr089E4fvxo8/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/getequity-9353cd69/FVKdWr089E4fvxo8/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/getequity-9353cd69/FVKdWr089E4fvxo8/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/getequity-9353cd69/FVKdWr089E4fvxo8/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/getequity-9353cd69/FVKdWr089E4fvxo8/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/getequity-9353cd69/FVKdWr089E4fvxo8/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Amend a bid - GetEquity\">\u003cmeta data-mint-head property=\"og:description\" content=\"Change the amount or limit on a live bid\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"GetEquity\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://getequity.io/docs/api-reference/endpoint/Trade/amend-commitment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://getequity-9353cd69.mintlify.site/docs/_mintlify/api/og/v2?division=Trade\u0026amp;title=Amend+a+bid\u0026amp;description=Change+the+amount+or+limit+on+a+live+bid\u0026amp;theme=eb6023f10b9af924ed87289e\u0026amp;signature=ee1adab45087f43d6f93640bad684b8f04a76560d2cf1fd622ed33d00ed7d85d\">\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=\"Amend a bid - GetEquity\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Change the amount or limit on a live bid\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://getequity-9353cd69.mintlify.site/docs/_mintlify/api/og/v2?division=Trade\u0026amp;title=Amend+a+bid\u0026amp;description=Change+the+amount+or+limit+on+a+live+bid\u0026amp;theme=eb6023f10b9af924ed87289e\u0026amp;signature=ee1adab45087f43d6f93640bad684b8f04a76560d2cf1fd622ed33d00ed7d85d\">\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=\"/docs/mintlify-assets/_mintlify/favicons/getequity-9353cd69/FVKdWr089E4fvxo8/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"GetEquity\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3d70fd\">\u003clink data-mint-head rel=\"canonical\" href=\"https://getequity.io/docs/api-reference/endpoint/Trade/amend-commitment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/endpoint/Trade/amend-commitment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://getequity.io/#organization\",\"name\":\"GetEquity\",\"url\":\"https://getequity.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/getequity-9353cd69/vgtVmrBA2jLoPm-V/logo/Light-001.png?fit=max\u0026auto=format\u0026n=vgtVmrBA2jLoPm-V\u0026q=85\u0026s=515177515afb51f52b712858383b6be7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://getequity.io/docs#website\",\"name\":\"GetEquity\",\"url\":\"https://getequity.io/docs\",\"publisher\":{\"@id\":\"https://getequity.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://getequity.io/docs/api-reference/endpoint/Trade/amend-commitment#webpage\",\"url\":\"https://getequity.io/docs/api-reference/endpoint/Trade/amend-commitment\",\"name\":\"Amend a bid\",\"description\":\"Change the amount or limit on a live bid\",\"dateModified\":\"2026-08-29T18:41:03.082Z\",\"isPartOf\":{\"@id\":\"https://getequity.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://getequity.io/docs/api-reference/endpoint/Trade/amend-commitment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://getequity.io/docs/api-reference/endpoint/Trade/amend-commitment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Investments API · Direct\",\"item\":\"https://getequity.io/docs/api-reference/investments/direct\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Trade\",\"item\":\"https://getequity.io/docs/api-reference/endpoint/Trade/trade\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Amend a bid\",\"item\":\"https://getequity.io/docs/api-reference/endpoint/Trade/amend-commitment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://getequity.io/docs/api-reference/endpoint/Trade/amend-commitment#apireference\",\"headline\":\"Amend a bid\",\"name\":\"Amend a bid\",\"description\":\"Change the amount or limit on a live bid\",\"url\":\"https://getequity.io/docs/api-reference/endpoint/Trade/amend-commitment\",\"mainEntityOfPage\":{\"@id\":\"https://getequity.io/docs/api-reference/endpoint/Trade/amend-commitment#webpage\"},\"dateModified\":\"2026-08-29T18:41:03.082Z\",\"publisher\":{\"@id\":\"https://getequity.io/#organization\"},\"isPartOf\":{\"@id\":\"https://getequity.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"GetEquity\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"GetEquity","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction"}]},{"anchor":"API Reference","icon":"code","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Choosing your integration","href":"/api-reference/choosing-your-integration"}]},{"group":"Investments API · Direct","pages":[{"title":"Direct model","href":"/api-reference/investments/direct"},{"group":"Trade","pages":[{"title":"Overview","href":"/api-reference/endpoint/Trade/trade"},{"title":"Fetch All Active Tokens","api":"GET api/tokens?closed=false\u0026exited=false","href":"/api-reference/endpoint/Trade/get-tokens"},{"title":"Fetch Raising Tokens","api":"GET api/tokens/raising","href":"/api-reference/endpoint/Trade/get-raising-tokens"},{"title":"Buy token","api":"POST api/token/{id}/buy","href":"/api-reference/endpoint/Trade/buy-token"},{"title":"Fund and Buy","api":"POST api/token/{id}/fund-buy","tag":"NEW","href":"/api-reference/endpoint/Trade/fund-buy"},{"title":"Sell token","api":"POST api/token/{id}/sell","href":"/api-reference/endpoint/Trade/sell-token"},{"title":"Get Asset","api":"GET api/asset/{id}","href":"/api-reference/endpoint/Trade/get-asset"},{"title":"Get Token","api":"GET api/token/{tokenId}","href":"/api-reference/endpoint/Trade/get-token"},{"title":"Token Historicals","api":"GET api/token/{id}/ohlvc","tag":"NEW","href":"/api-reference/endpoint/Trade/token-historicals"},{"title":"Search Token","api":"GET api/token/search","href":"/api-reference/endpoint/Trade/search-token"},{"title":"Bid into an offering","api":"POST api/token/{id}/commit","href":"/api-reference/endpoint/Trade/commit-to-offering"},{"title":"Fetch the order book","api":"GET api/token/{id}/book","description":"Aggregate demand, cover and the demand ladder","href":"/api-reference/endpoint/Trade/offering-book"},{"title":"Amend a bid","api":"PATCH api/commitment/{commitmentId}","href":"/api-reference/endpoint/Trade/amend-commitment"},{"title":"Withdraw a bid","api":"DELETE api/commitment/{commitmentId}","description":"Pull a bid and release the held funds","href":"/api-reference/endpoint/Trade/withdraw-commitment"},{"title":"List your bids","api":"GET api/commitments","href":"/api-reference/endpoint/Trade/list-commitments"}]},{"group":"Customers","pages":[{"title":"Overview","href":"/api-reference/endpoint/Customers/customers"},{"title":"Fetch All Customers","api":"GET api/customers","href":"/api-reference/endpoint/Customers/get-customers"},{"title":"Search For a Customer","api":"GET api/customers/search","href":"/api-reference/endpoint/Customers/search-customers"}]},{"group":"Orders","pages":[{"title":"Overview","href":"/api-reference/endpoint/Orders/orders"},{"title":"Fetch Active Buy Orders","api":"GET api/orders/token/{id}?type=buy\u0026status=Active","href":"/api-reference/endpoint/Orders/get-buy-orders"},{"title":"Fetch Active Sell Orders","api":"GET api/orders/token/{id}?type=sell\u0026status=Active","href":"/api-reference/endpoint/Orders/get-sell-orders"},{"title":"Fetch an Order","api":"GET api/orders/{orderId}","href":"/api-reference/endpoint/Orders/get-order"},{"title":"Cancel an Order","api":"POST api/orders/{orderId}/cancel","tag":"NEW","href":"/api-reference/endpoint/Orders/cancel-order"}]},{"group":"Transactions","pages":[{"title":"Overview","href":"/api-reference/endpoint/Transactions/transactions"},{"title":"Fetch a transaction / verify a payment","api":"GET api/transactions/{reference}","tag":"NEW","href":"/api-reference/endpoint/Transactions/get-transaction"},{"title":"Fetch Customer Transactions","api":"GET api/customers/transactions","href":"/api-reference/endpoint/Transactions/get-customer-transactions"},{"title":"Fetch Total Transaction Volume","api":"GET api/transactions/volume","href":"/api-reference/endpoint/Transactions/get-total-transaction-volume"}]},{"group":"Wallet","pages":[{"title":"Overview","href":"/api-reference/endpoint/Wallet/wallet"},{"title":"Fund wallet","api":"POST api/wallet/fund","href":"/api-reference/endpoint/Wallet/fund-wallet"},{"title":"Withdraw from wallet","api":"POST api/wallet/withdraw","href":"/api-reference/endpoint/Wallet/withdraw"},{"title":"Get All Currencies Wallet Balance","api":"GET api/token/currencies/balance","href":"/api-reference/endpoint/Wallet/get-currencies-balance"},{"title":"Fetch Wallet Balance","api":"GET api/token/{symbol}/balance","href":"/api-reference/endpoint/Wallet/get-wallet-balance"},{"title":"Refresh Wallet Balance","api":"GET api/wallet/refresh","href":"/api-reference/endpoint/Wallet/refresh-wallet-balance"}]}]},{"group":"Investments API · Managed","pages":[{"title":"Managed model","href":"/api-reference/investments/managed"},{"group":"Members","pages":[{"title":"Overview","href":"/api-reference/endpoint/Members/members"},{"title":"Create Member","api":"POST api/member","href":"/api-reference/endpoint/Members/create-member"},{"title":"Get Members","api":"GET api/member","href":"/api-reference/endpoint/Members/get-members"},{"title":"Get member by email","api":"GET api/member?email={email}","tag":"NEW","href":"/api-reference/endpoint/Members/get-member-by-email"},{"title":"Get member balance","api":"GET api/members/{id}/balance","href":"/api-reference/endpoint/Members/member-currency-balance"},{"title":"Get Member token balance","api":"GET api/members/{id}/tokens","href":"/api-reference/endpoint/Members/member-token-balance"},{"title":"Get Member transactions","api":"GET api/members/{id}/transactions","href":"/api-reference/endpoint/Members/member-transactions"},{"title":"Get member orders","api":"GET api/members/{id}/orders","href":"/api-reference/endpoint/Members/member-orders"},{"title":"Buy token as member","api":"POST api/members/{id}/token/{tokenId}/buy","href":"/api-reference/endpoint/Members/buy-token"},{"title":"Fund and Invest","api":"POST api/members/{id}/token/{tokenId}/fund-invest","href":"/api-reference/endpoint/Members/fund-invest"},{"title":"Get Fund and Invest Quote","api":"POST api/members/{id}/token/{tokenId}/fund-invest/quote","href":"/api-reference/endpoint/Members/fund-invest-quote"},{"title":"Sell token as member","api":"POST api/members/{id}/token/{tokenID}/sell","href":"/api-reference/endpoint/Members/sell-token"},{"title":"Fund member wallet","api":"POST api/members/{id}/wallet/fund","href":"/api-reference/endpoint/Members/fund-member-wallet"},{"title":"Withdraw from member wallet","api":"POST api/members/{id}/wallet/withdraw","href":"/api-reference/endpoint/Members/withdraw-member-wallet"},{"title":"Cancel a member order","api":"POST api/members/{id}/orders/{orderId}/cancel","tag":"NEW","href":"/api-reference/endpoint/Members/cancel-member-order"},{"title":"Bid into an offering for a member","api":"POST api/members/{id}/token/{tokenId}/commit","href":"/api-reference/endpoint/Members/member-commit-to-offering"},{"title":"Member amend commitment","href":"/api-reference/endpoint/Members/member-amend-commitment"},{"title":"Member withdraw commitment","href":"/api-reference/endpoint/Members/member-withdraw-commitment"},{"title":"Member list commitments","href":"/api-reference/endpoint/Members/member-list-commitments"}]}]},{"group":"Credit API","pages":[{"title":"Overview","href":"/api-reference/endpoint/CreditLoan/credit-loan"},{"title":"Get Loan Configuration","api":"GET api/credit/loan-configuration","href":"/api-reference/endpoint/CreditLoan/get-loan-configuration"},{"title":"Get User by ID","api":"POST api/user/safe/{userId}","href":"/api-reference/endpoint/CreditLoan/get-user-by-id"},{"title":"Get User Investments","api":"POST api/credit/user/portfolio/{userId}","href":"/api-reference/endpoint/CreditLoan/get-user-investments"},{"title":"Create Loan","api":"POST api/credit/loan","href":"/api-reference/endpoint/CreditLoan/create-loan"},{"title":"Get Loans By Creditor","api":"GET api/creditor/credit/loans","href":"/api-reference/endpoint/CreditLoan/get-creditor-loans"},{"title":"Get Loan By ID","api":"GET api/credit/loan/{loanId}","href":"/api-reference/endpoint/CreditLoan/get-loan-by-id"},{"title":"Repay Loan","api":"PUT api/borrower/credit/loan/{loanId}/repay","href":"/api-reference/endpoint/CreditLoan/repay-loan"}]},{"group":"Webhook","pages":[{"title":"Overview","href":"/api-reference/endpoint/Webhook/webhook"},{"group":"Events","pages":[{"title":"member.created","href":"/api-reference/endpoint/Webhook/member-created"},{"title":"order.created","href":"/api-reference/endpoint/Webhook/order-created"},{"title":"order.cancelled","href":"/api-reference/endpoint/Webhook/order-cancelled"},{"title":"transaction.created","href":"/api-reference/endpoint/Webhook/transaction-created"},{"title":"wallet.funded","href":"/api-reference/endpoint/Webhook/wallet-funded"},{"title":"listing.created","href":"/api-reference/endpoint/Webhook/listing-created"},{"title":"token.transferred","href":"/api-reference/endpoint/Webhook/token-transferred"},{"title":"withdrawal.created","href":"/api-reference/endpoint/Webhook/withdrawal-created"},{"title":"withdrawal.approved","href":"/api-reference/endpoint/Webhook/withdrawal-approved"},{"title":"loan.created","href":"/api-reference/endpoint/Webhook/loan-created"},{"title":"loan.repaid","href":"/api-reference/endpoint/Webhook/loan-repaid"},{"title":"esop.transferred","href":"/api-reference/endpoint/Webhook/esop-transferred"},{"title":"token.gifted","href":"/api-reference/endpoint/Webhook/token-gifted"},{"title":"token.gift.accepted","href":"/api-reference/endpoint/Webhook/token-gift-accepted"}]}]}]},{"anchor":"On-Chain","icon":"link","pages":[{"title":"On-Chain","href":"/onchain/introduction"}]},{"anchor":"Change Log","icon":"clock","pages":[{"title":"Change Log","href":"/change-log/change-log"}]},{"anchor":"Blog","icon":"newspaper","href":"https://www.getequity.io/blog"},{"anchor":"FAQs","icon":"question","href":"https://www.getequity.io/faq/"},{"anchor":"Support","icon":"envelope","href":"mailto:support@getequity.io"}]},"basePath":"","title":"Amend a bid - GetEquity","buildId":"dpl_BSPUBxEoKhhK7HzXVDPxdPvWx4xc","deploymentId":"dpl_BSPUBxEoKhhK7HzXVDPxdPvWx4xc","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-Do6EtGSl.js","utils-id4tQ6My.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-Byrixac4.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-nakYa3Zl.js","snippetPresets-Bq-pUS7h.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-CujTC_9K.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-FneVUsVu.js","shallow-DY9WpUCz.js","getApiPlaygroundDisplay-Bz8WpPfA.js","CodeSnippet-DgCuJg4G.js","CodeSnippets-Dub9c4T0.js","Page-CePXnjd1.js","getPastedJson-xdI8y2XB.js","icon--yVw5vkr.js","MethodPill-C47t7MdS.js","DuplicateIcon-BzwJ2LeC.js","createIcon-BzggGy84.js","DynamicMarkdown-AlxJK8VR.js","SectionHeading-CMlwFxdK.js","axios-vUo_bRtp.js"]}