{"id":193947,"date":"2023-07-25T10:49:28","date_gmt":"2023-07-25T14:49:28","guid":{"rendered":"https:\/\/ibkrcampus.com\/?post_type=trading-lessons&p=193947"},"modified":"2025-02-11T16:19:07","modified_gmt":"2025-02-11T21:19:07","slug":"launching-and-authenticating-the-gateway","status":"publish","type":"trading-lessons","link":"https:\/\/www.interactivebrokers.com\/campus\/trading-lessons\/launching-and-authenticating-the-gateway\/","title":{"rendered":"Launching and Authenticating the Gateway"},"content":{"rendered":"\n

Hello, and welcome to this lesson on the Interactive Brokers Client Portal API. In this tutorial, we will be covering how to configure the Client Portal Gateway, how to authenticate on the Gateway and how to confirm your authentication status. To begin, lets go to the Client Portal API documentation at interactivebrokers.github.io\/cpwebapi. The documentation provides all the information you\u2019ll need for utilizing the Client Portal API.<\/p>\n\n\n\n

Please note that you will need to have an opened and funded Interactive Brokers account to be able to connect through the Client Portal API.<\/p>\n\n\n\n

Setting up and running the Client Portal API Gateway<\/strong><\/h4>\n\n\n\n

To begin, let\u2019s first navigate to the Client Portal documentation site, and click on the Quickstart tab on the left. Then, on top right of the Quickstart page you should see the API Gateway and Java download panel for downloading the gateway software and Java installer. The gateway is a Java based program that requires a Java Runtime Environment (JRE) running on your machine. To check if you already have a JRE running, please open the command prompt and type the command \u2018java \u2013version\u2019. If you received \u201c’java’ is not recognized as an internal or external command\u201d message, please download and install the Java on your machine following the Java download link. Otherwise, it should return the details of the Java & JRE version, and you are ready to download, extract, and run the gateway. By default, the Client Portal Gateway\u2019s ZIP file will download to your user\u2019s Downloads folder.<\/p>\n\n\n\n

Once you have everything downloaded and installed, it is time to run the Gateway and get authenticated. Firstly, open a command prompt terminal and navigate to the directory that you extracted the clientportal.gw folder from step 2.  To do this, use the command \u2018cd {Your Directory}\\clientportal.gw\u2019. Once you are inside the directory, run the command \u2018bin\\run.bat root\\conf.yaml\u2019 for Windows or \u2018bin\/run.sh root\/conf.yaml\u2019 for Unix. Keep in mind to leave this window open while using the Client Portal gateway.<\/p>\n\n\n\n

After the new window has been opened, the gateway should be up and running, and it\u2019s ready to authenticate the user\u2019s session. Let\u2019s open a browser and navigate to https:\/\/localhost:5000 on your local network then login with your Live or Paper Account credentials.<\/p>\n\n\n\n

Please note that you cannot be logged into the account you are authenticating with anywhere else before you authenticate. You should make sure to log out of the account before attempting to authenticate by using the \u201cLog Out\u201d option on our other platforms. Just closing the window or application may cause a stale login session that could prevent the authentication from working properly so using the log out option is important. If the authentication is successful, a new page will load with the message \u2018Client login succeeds\u2019. If the page reloads back to this page again, simply log in again.<\/p>\n\n\n\n

For any questions you may have regarding authentication, please visit our Authentication page in our documentation, as your question may already be answered here. A few important questions to highlight are: \u201cHow long does a session remain authenticated?\u201d, and \u201cHow can I prevent the session from timing out?\u201d<\/p>\n\n\n\n

Update gateway certificate<\/strong><\/h4>\n\n\n\n

The gateway comes with a default certificate. This will likely present an insecure server message when navigating to the page and making requests to your localhost. It is important to note that the insecure connection is between you and your localhost, or the connection on the same machine. The connection between the localhost and Interactive Brokers will remain secure. However, you may replace it with your own self-signed certificate or public certificate. To update the gateway certificate, replace the default certificate with your own certificate under the gateway directory \\root and modify the sslCert and sslPwd fields in the conf.yaml file. And if your gateway was already running, be sure to restart the program.<\/p>\n\n\n\n

Using \/auth\/status<\/strong><\/h4>\n\n\n\n

Now, let\u2019s start writing a simple program to confirm our authentication status. This can be called at any point to confirm authentication status on your machine. I will start by creating a new Python program and importing a few modules. We can do this by writing \u201cimport requests\u201d.<\/p>\n\n\n\n

I will also import a library called \u201curllib3\u201d. This library gives us access to a method to disable SSL errors when using the default certificate. This is not a required module and is used purely for aesthetics. With this, I will write a quick call for \u201curllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)\u201d<\/p>\n\n\n\n

I will also create a confirmStatus() method that contains no arguments. For the moment, I will only put \u201cpass\u201d in this method. Afterwards, I will create the Python Name-Main idiom to automatically run our method if this is the primary file, and reference our confirmStatus() method.<\/p>\n\n\n\n

With our framework complete, we can return to our confirmStatus() method to call the endpoint. I will begin with a variable, base_url, and set it equal to \u201chttps:\/\/localhost:5000\/v1\/api\/\u201d. This is the standard base URL for all requests in the Client Portal API. Now, I will create a variable called \u2018endpoint\u2019 which I\u2019ll set to \u201ciserver\/auth\/status\u201d.<\/p>\n\n\n\n

Next, we can build the request. To do this, I will call my variable, auth_req, and set it equal to \u201crequests.get(url=base_url+endpoint, verify=False)\u201d. This will create an http GET request, with a targeted URL of our combined base url and endpoint, or \u201chttps:\/\/localhost:5000\/v1\/api\/iserver\/auth\/status\u201d. I had also set the \u2018verify\u2019 parameter to False, so that we do not require SSL verification on our request. Finally, I will print the \u201cauth_req\u201d variable, as well as \u201cauth_req.text\u201d this will print both the response as well as the response body. Now we can run the code.<\/p>\n\n\n\n

If we take a look at our response in the terminal, I can see we received a \u201c<Response [200]>\u201d indicating an \u201cOK\u201d response. This indicates a successful request. Below that, we can see our body, indicating our authentication and connected status\u2019. While there are more values returned, most of these are inconsequential. If we see \u201cconnected\u201d equal to false, there may be an issue with the gateway, and you may wish to relaunch your application. If we see \u201cauthenticated\u201d to false, your brokerage session is not authenticated. This can mean that either a stale session prevented your login, or you have recently logged in elsewhere, such as the Trader Workstation. This can end your Client Portal session.<\/p>\n\n\n\n

Given our Authenticated and Connected status\u2019 showing \u2018true\u2019, that means we are fully authenticated and connected and are now ready to send additional queries for market data or order placement.<\/p>\n\n\n\n

Thank you for watching this lesson on Configuring the Client Portal Gateway in the Client Portal API. If you find this lesson helpful, please check out our other lessons in the Client Portal API tutorial series.<\/p>\n\n\n\n

Code Snippet – confirmStatus.py<\/h4>\n\n\n\n
import requests\n\n# Disable SSL Warnings\nimport urllib3\nurllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)\n\n# reauthenticate\ndef confirmStatus():\n    base_url = \"https:\/\/localhost:5000\/v1\/api\/\"\n    endpoint = \"iserver\/auth\/status\"\n    \n    auth_req = requests.get(url=base_url+endpoint,verify=False)\n    print(auth_req)\n    print(auth_req.text)\n\nif __name__ == \"__main__\":\n    confirmStatus()<\/pre>\n","protected":false},"excerpt":{"rendered":"
In this lesson, we will be discussing how to download and run the client portal gateway. This will also discuss the requirements for the program, as well as discussing means to confirm authentication for the platform.<\/p>\n","protected":false},"author":850,"featured_media":221324,"parent":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"_acf_changed":false,"footnotes":""},"contributors-categories":[13576],"traders-academy":[13126,13128,13132],"class_list":{"0":"post-193947","1":"trading-lessons","2":"type-trading-lessons","3":"status-publish","4":"has-post-thumbnail","6":"contributors-categories-interactive-brokers","7":"traders-academy-intermediate-trading","8":"traders-academy-level","9":"traders-academy-trading-lesson"},"pp_statuses_selecting_workflow":false,"pp_workflow_action":"current","pp_status_selection":"publish","acf":[],"yoast_head":"\nArchives | Traders' Academy | IBKR Campus<\/title>\n<meta name=\"description\" content=\"In this lesson, we will be discussing how to download and run the client portal gateway. This will also discuss the requirements for the program, as...\" \/>\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\/wp-json\/wp\/v2\/trading-lessons\/193947\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Launching and Authenticating the Gateway | IBKR Campus US\" \/>\n<meta property=\"og:description\" content=\"In this lesson, we will be discussing how to download and run the client portal gateway. This will also discuss the requirements for the program, as well as discussing means to confirm authentication for the platform.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.interactivebrokers.com\/campus\/trading-lessons\/launching-and-authenticating-the-gateway\/\" \/>\n<meta property=\"og:site_name\" content=\"IBKR Campus US\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-11T21:19:07+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=\"5 minutes\" \/>\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:\\\/\\\/ibkrcampus.com\\\/campus\\\/trading-lessons\\\/launching-and-authenticating-the-gateway\\\/\",\n\t            \"url\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/trading-lessons\\\/launching-and-authenticating-the-gateway\\\/\",\n\t            \"name\": \"Launching and Authenticating the Gateway | IBKR Campus US\",\n\t            \"isPartOf\": {\n\t                \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/#website\"\n\t            },\n\t            \"primaryImageOfPage\": {\n\t                \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/trading-lessons\\\/launching-and-authenticating-the-gateway\\\/#primaryimage\"\n\t            },\n\t            \"image\": {\n\t                \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/trading-lessons\\\/launching-and-authenticating-the-gateway\\\/#primaryimage\"\n\t            },\n\t            \"thumbnailUrl\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/wp-content\\\/uploads\\\/sites\\\/2\\\/2023\\\/07\\\/mqdefault.jpg\",\n\t            \"datePublished\": \"2023-07-25T14:49:28+00:00\",\n\t            \"dateModified\": \"2025-02-11T21:19:07+00:00\",\n\t            \"description\": \"In this lesson, we will be discussing how to download and run the client portal gateway. This will also discuss the requirements for the program, as well as discussing means to confirm authentication for the platform.\",\n\t            \"breadcrumb\": {\n\t                \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/trading-lessons\\\/launching-and-authenticating-the-gateway\\\/#breadcrumb\"\n\t            },\n\t            \"inLanguage\": \"en-US\",\n\t            \"potentialAction\": [\n\t                {\n\t                    \"@type\": \"ReadAction\",\n\t                    \"target\": [\n\t                        \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/trading-lessons\\\/launching-and-authenticating-the-gateway\\\/\"\n\t                    ]\n\t                }\n\t            ]\n\t        },\n\t        {\n\t            \"@type\": \"ImageObject\",\n\t            \"inLanguage\": \"en-US\",\n\t            \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/trading-lessons\\\/launching-and-authenticating-the-gateway\\\/#primaryimage\",\n\t            \"url\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/wp-content\\\/uploads\\\/sites\\\/2\\\/2023\\\/07\\\/mqdefault.jpg\",\n\t            \"contentUrl\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/wp-content\\\/uploads\\\/sites\\\/2\\\/2023\\\/07\\\/mqdefault.jpg\",\n\t            \"width\": 320,\n\t            \"height\": 180,\n\t            \"caption\": \"Launching and Authenticating the Gateway\"\n\t        },\n\t        {\n\t            \"@type\": \"BreadcrumbList\",\n\t            \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/trading-lessons\\\/launching-and-authenticating-the-gateway\\\/#breadcrumb\",\n\t            \"itemListElement\": [\n\t                {\n\t                    \"@type\": \"ListItem\",\n\t                    \"position\": 1,\n\t                    \"name\": \"Academy Lessons\",\n\t                    \"item\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/trading-lessons\\\/\"\n\t                },\n\t                {\n\t                    \"@type\": \"ListItem\",\n\t                    \"position\": 2,\n\t                    \"name\": \"Launching and Authenticating the Gateway\"\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 | Traders' Academy | IBKR Campus","description":"In this lesson, we will be discussing how to download and run the client portal gateway. This will also discuss the requirements for the program, as...","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\/wp-json\/wp\/v2\/trading-lessons\/193947\/","og_locale":"en_US","og_type":"article","og_title":"Launching and Authenticating the Gateway | IBKR Campus US","og_description":"In this lesson, we will be discussing how to download and run the client portal gateway. This will also discuss the requirements for the program, as well as discussing means to confirm authentication for the platform.","og_url":"https:\/\/www.interactivebrokers.com\/campus\/trading-lessons\/launching-and-authenticating-the-gateway\/","og_site_name":"IBKR Campus US","article_modified_time":"2025-02-11T21:19:07+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/ibkrcampus.com\/campus\/trading-lessons\/launching-and-authenticating-the-gateway\/","url":"https:\/\/ibkrcampus.com\/campus\/trading-lessons\/launching-and-authenticating-the-gateway\/","name":"Launching and Authenticating the Gateway | IBKR Campus US","isPartOf":{"@id":"https:\/\/ibkrcampus.com\/campus\/#website"},"primaryImageOfPage":{"@id":"https:\/\/ibkrcampus.com\/campus\/trading-lessons\/launching-and-authenticating-the-gateway\/#primaryimage"},"image":{"@id":"https:\/\/ibkrcampus.com\/campus\/trading-lessons\/launching-and-authenticating-the-gateway\/#primaryimage"},"thumbnailUrl":"https:\/\/www.interactivebrokers.com\/campus\/wp-content\/uploads\/sites\/2\/2023\/07\/mqdefault.jpg","datePublished":"2023-07-25T14:49:28+00:00","dateModified":"2025-02-11T21:19:07+00:00","description":"In this lesson, we will be discussing how to download and run the client portal gateway. This will also discuss the requirements for the program, as well as discussing means to confirm authentication for the platform.","breadcrumb":{"@id":"https:\/\/ibkrcampus.com\/campus\/trading-lessons\/launching-and-authenticating-the-gateway\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ibkrcampus.com\/campus\/trading-lessons\/launching-and-authenticating-the-gateway\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/ibkrcampus.com\/campus\/trading-lessons\/launching-and-authenticating-the-gateway\/#primaryimage","url":"https:\/\/www.interactivebrokers.com\/campus\/wp-content\/uploads\/sites\/2\/2023\/07\/mqdefault.jpg","contentUrl":"https:\/\/www.interactivebrokers.com\/campus\/wp-content\/uploads\/sites\/2\/2023\/07\/mqdefault.jpg","width":320,"height":180,"caption":"Launching and Authenticating the Gateway"},{"@type":"BreadcrumbList","@id":"https:\/\/ibkrcampus.com\/campus\/trading-lessons\/launching-and-authenticating-the-gateway\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Academy Lessons","item":"https:\/\/ibkrcampus.com\/campus\/trading-lessons\/"},{"@type":"ListItem","position":2,"name":"Launching and Authenticating the Gateway"}]},{"@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\/trading-lessons\/193947","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/trading-lessons"}],"about":[{"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/types\/trading-lessons"}],"author":[{"embeddable":true,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/users\/850"}],"replies":[{"embeddable":true,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/comments?post=193947"}],"version-history":[{"count":0,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/trading-lessons\/193947\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/media\/221324"}],"wp:attachment":[{"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/media?parent=193947"}],"wp:term":[{"taxonomy":"contributors-categories","embeddable":true,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/contributors-categories?post=193947"},{"taxonomy":"traders-academy","embeddable":true,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/traders-academy?post=193947"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}