{"id":195868,"date":"2023-09-06T12:06:51","date_gmt":"2023-09-06T16:06:51","guid":{"rendered":"https:\/\/ibkrcampus.com\/?post_type=ibkr-api-page&#038;p=195868"},"modified":"2024-08-20T11:42:42","modified_gmt":"2024-08-20T15:42:42","slug":"webapi-doc","status":"publish","type":"ibkr-api-page","link":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-api-page\/webapi-doc\/","title":{"rendered":"Web API Documentation"},"content":{"rendered":"\n<div class=\"row\">\n\t\t<div class=\"col-sm-12 col-md-8\">\n\t\t\t<p class=\"text-large\">Please be aware that IBKR&#8217;s unified Web API documentation and reference materials are in beta and subject to change. The existing documentation for the Client Portal Web API, Digital Account Management, and the Flex Web Service will remain available at the following locations:<\/p>\n\t\t\t<button type=\"button\" class=\"ref-btn btn btn-xs btn-default btn-primary mb-2\"><a style=\"color: #fff\" href=\"\/ibkr-api-page\/cpapi-v1\/\">Client Portal Web API<\/a><\/button>\n\t\t\t<?php if(global_var('entity') == 'us'): ?>\n\t\t\t<button type=\"button\" class=\"ref-btn btn btn-xs btn-default btn-primary mb-2\"><a style=\"color: #fff\" href=\"https:\/\/www.ibkrguides.com\/dameca\/References\/Introduction.htm\" target=\"_blank\" rel=\"noopener\">Digital Account Management<\/a><\/button>\n\t\t\t<?php endif ?>\n\t\t\t<button type=\"button\" class=\"ref-btn btn btn-xs btn-default btn-primary mb-2\"><a style=\"color: #fff\" href=\"\/ibkr-api-page\/flex-web-service\/\">Flex Web Service<\/a><\/button>\n\t\t<\/div>\n\t<\/div>\n","protected":false},"excerpt":{"rendered":"<p>Please be aware that IBKR&#8217;s unified Web API documentation and reference materials are in beta and subject to change. The existing documentation for the Client Portal Web API, Digital Account Management, and the Flex Web Service will remain available at the following locations: Client Portal Web API Digital Account Management Flex Web Service<\/p>\n","protected":false},"featured_media":0,"parent":0,"template":"templates-api\/template-api-markdown.php","meta":{"_acf_changed":true,"footnotes":""},"ibkr-api":[],"ibkr-reporting":[],"class_list":["post-195868","ibkr-api-page","type-ibkr-api-page","status-publish"],"pp_statuses_selecting_workflow":false,"pp_workflow_action":"current","pp_status_selection":"publish","acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v26.9 (Yoast SEO v27.3) - https:\/\/yoast.com\/product\/yoast-seo-premium-wordpress\/ -->\n<title>Archives | IBKR API | IBKR Campus<\/title>\n<meta name=\"description\" content=\"Interactive Brokers\u2019 Client Portal API utilizes a HTTP structure alongside a localhost client to manage requests for market data, orders, and account...\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.interactivebrokers.com\/campus\/ibkr-api-page\/cpapi\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Web API Documentation | IBKR Campus US\" \/>\n<meta property=\"og:description\" content=\"Interactive Brokers\u2019 Client Portal API utilizes a HTTP structure alongside a localhost client to manage requests for market data, orders, and account management.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.interactivebrokers.com\/campus\/ibkr-api-page\/cpapi\/\" \/>\n<meta property=\"og:site_name\" content=\"IBKR Campus US\" \/>\n<meta property=\"article:modified_time\" content=\"2024-08-20T15:42:42+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\n\t    \"@context\": \"https:\\\/\\\/schema.org\",\n\t    \"@graph\": [\n\t        {\n\t            \"@type\": \"WebPage\",\n\t            \"@id\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/ibkr-api-page\\\/webapi-doc\\\/\",\n\t            \"url\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/ibkr-api-page\\\/cpapi\\\/\",\n\t            \"name\": \"Web API Documentation | IBKR Campus US\",\n\t            \"isPartOf\": {\n\t                \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/#website\"\n\t            },\n\t            \"datePublished\": \"2023-09-06T16:06:51+00:00\",\n\t            \"dateModified\": \"2024-08-20T15:42:42+00:00\",\n\t            \"description\": \"Interactive Brokers\u2019 Client Portal API utilizes a HTTP structure alongside a localhost client to manage requests for market data, orders, and account management.\",\n\t            \"breadcrumb\": {\n\t                \"@id\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/ibkr-api-page\\\/cpapi\\\/#breadcrumb\"\n\t            },\n\t            \"inLanguage\": \"en-US\",\n\t            \"potentialAction\": [\n\t                {\n\t                    \"@type\": \"ReadAction\",\n\t                    \"target\": [\n\t                        \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/ibkr-api-page\\\/cpapi\\\/\"\n\t                    ]\n\t                }\n\t            ]\n\t        },\n\t        {\n\t            \"@type\": \"BreadcrumbList\",\n\t            \"@id\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/ibkr-api-page\\\/cpapi\\\/#breadcrumb\",\n\t            \"itemListElement\": [\n\t                {\n\t                    \"@type\": \"ListItem\",\n\t                    \"position\": 1,\n\t                    \"name\": \"API\",\n\t                    \"item\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/ibkr-api-page\\\/\"\n\t                },\n\t                {\n\t                    \"@type\": \"ListItem\",\n\t                    \"position\": 2,\n\t                    \"name\": \"Web API Documentation\"\n\t                }\n\t            ]\n\t        },\n\t        {\n\t            \"@type\": \"WebSite\",\n\t            \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/#website\",\n\t            \"url\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/\",\n\t            \"name\": \"IBKR Campus US\",\n\t            \"description\": \"Financial Education from Interactive Brokers\",\n\t            \"publisher\": {\n\t                \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/#organization\"\n\t            },\n\t            \"potentialAction\": [\n\t                {\n\t                    \"@type\": \"SearchAction\",\n\t                    \"target\": {\n\t                        \"@type\": \"EntryPoint\",\n\t                        \"urlTemplate\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/?s={search_term_string}\"\n\t                    },\n\t                    \"query-input\": {\n\t                        \"@type\": \"PropertyValueSpecification\",\n\t                        \"valueRequired\": true,\n\t                        \"valueName\": \"search_term_string\"\n\t                    }\n\t                }\n\t            ],\n\t            \"inLanguage\": \"en-US\"\n\t        },\n\t        {\n\t            \"@type\": \"Organization\",\n\t            \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/#organization\",\n\t            \"name\": \"Interactive Brokers\",\n\t            \"alternateName\": \"IBKR\",\n\t            \"url\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/\",\n\t            \"logo\": {\n\t                \"@type\": \"ImageObject\",\n\t                \"inLanguage\": \"en-US\",\n\t                \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/#\\\/schema\\\/logo\\\/image\\\/\",\n\t                \"url\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/wp-content\\\/uploads\\\/sites\\\/2\\\/2024\\\/05\\\/ibkr-campus-logo.jpg\",\n\t                \"contentUrl\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/wp-content\\\/uploads\\\/sites\\\/2\\\/2024\\\/05\\\/ibkr-campus-logo.jpg\",\n\t                \"width\": 669,\n\t                \"height\": 669,\n\t                \"caption\": \"Interactive Brokers\"\n\t            },\n\t            \"image\": {\n\t                \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/#\\\/schema\\\/logo\\\/image\\\/\"\n\t            },\n\t            \"publishingPrinciples\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/about-ibkr-campus\\\/\",\n\t            \"ethicsPolicy\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/cyber-security-notice\\\/\"\n\t        }\n\t    ]\n\t}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Archives | IBKR API | IBKR Campus","description":"Interactive Brokers\u2019 Client Portal API utilizes a HTTP structure alongside a localhost client to manage requests for market data, orders, and account...","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-api-page\/cpapi\/","og_locale":"en_US","og_type":"article","og_title":"Web API Documentation | IBKR Campus US","og_description":"Interactive Brokers\u2019 Client Portal API utilizes a HTTP structure alongside a localhost client to manage requests for market data, orders, and account management.","og_url":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-api-page\/cpapi\/","og_site_name":"IBKR Campus US","article_modified_time":"2024-08-20T15:42:42+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-api-page\/webapi-doc\/","url":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-api-page\/cpapi\/","name":"Web API Documentation | IBKR Campus US","isPartOf":{"@id":"https:\/\/ibkrcampus.com\/campus\/#website"},"datePublished":"2023-09-06T16:06:51+00:00","dateModified":"2024-08-20T15:42:42+00:00","description":"Interactive Brokers\u2019 Client Portal API utilizes a HTTP structure alongside a localhost client to manage requests for market data, orders, and account management.","breadcrumb":{"@id":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-api-page\/cpapi\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.interactivebrokers.com\/campus\/ibkr-api-page\/cpapi\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-api-page\/cpapi\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"API","item":"https:\/\/ibkrcampus.com\/campus\/ibkr-api-page\/"},{"@type":"ListItem","position":2,"name":"Web API Documentation"}]},{"@type":"WebSite","@id":"https:\/\/ibkrcampus.com\/campus\/#website","url":"https:\/\/ibkrcampus.com\/campus\/","name":"IBKR Campus US","description":"Financial Education from Interactive Brokers","publisher":{"@id":"https:\/\/ibkrcampus.com\/campus\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/ibkrcampus.com\/campus\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/ibkrcampus.com\/campus\/#organization","name":"Interactive Brokers","alternateName":"IBKR","url":"https:\/\/ibkrcampus.com\/campus\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/ibkrcampus.com\/campus\/#\/schema\/logo\/image\/","url":"https:\/\/www.interactivebrokers.com\/campus\/wp-content\/uploads\/sites\/2\/2024\/05\/ibkr-campus-logo.jpg","contentUrl":"https:\/\/www.interactivebrokers.com\/campus\/wp-content\/uploads\/sites\/2\/2024\/05\/ibkr-campus-logo.jpg","width":669,"height":669,"caption":"Interactive Brokers"},"image":{"@id":"https:\/\/ibkrcampus.com\/campus\/#\/schema\/logo\/image\/"},"publishingPrinciples":"https:\/\/www.interactivebrokers.com\/campus\/about-ibkr-campus\/","ethicsPolicy":"https:\/\/www.interactivebrokers.com\/campus\/cyber-security-notice\/"}]}},"_links":{"self":[{"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/ibkr-api-page\/195868","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/ibkr-api-page"}],"about":[{"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/types\/ibkr-api-page"}],"version-history":[{"count":0,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/ibkr-api-page\/195868\/revisions"}],"wp:attachment":[{"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/media?parent=195868"}],"wp:term":[{"taxonomy":"ibkr-api","embeddable":true,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/ibkr-api?post=195868"},{"taxonomy":"ibkr-reporting","embeddable":true,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/ibkr-reporting?post=195868"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}