{"id":11808,"date":"2019-07-25T12:28:34","date_gmt":"2019-07-25T16:28:34","guid":{"rendered":"https:\/\/ibkrcampus.com\/?p=11808"},"modified":"2023-01-20T15:09:22","modified_gmt":"2023-01-20T20:09:22","slug":"ibkr-python-api-four-key-syntax-attributes-to-define-a-contract","status":"publish","type":"post","link":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-quant-news\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\/","title":{"rendered":"IBKR Python API – Four Key Syntax Attributes to Define a Contract"},"content":{"rendered":"\n
\"Python<\/figure>\n\n\n\n

The ContractSamples.py<\/strong> sheet from our Python1 <\/sup>Testbed<\/code> sample2<\/sup> will help you learn the syntax needed to define contracts in algo trading systems. These four are considered key class attributes<\/em>:<\/p>\n\n\n\n

contract.symbol<\/strong>
contract.secType<\/strong>
contract.currency<\/strong>
contract.exchange <\/strong><\/p>\n\n\n\n

Examples: EUR\/GBP FX contract<\/em><\/p>\n\n\n\n

   @staticmethod
    def EurGbpFx():
        #! [cashcontract]
        contract = Contract()
        contract.symbol = \"EUR\"
        contract.secType = \"CASH\"
        contract.currency = \"GBP\"
        contract.exchange = \"IDEALPRO\"
        #! [cashcontract]
        return contract<\/code><\/p>\n\n\n\n

For more examples, download the ContractSamples.py <\/strong>from the repository:  <\/strong>https:\/\/interactivebrokers.github.io\/<\/a> <\/p>\n\n\n\n

In addition, be sure to add us to your GitHub<\/a> watch list to keep up with more advanced contract syntax techniques.<\/p>\n\n\n\n

\"GitHub <\/p>\n\n\n\n

  1. Python\n3.0 version required.<\/em><\/li>
  2. Copyright\n(C) 2016 Interactive Brokers LLC. All rights reserved.  This code is subject to the terms and\nconditions of the IB API Non-Commercial License or the IB API Commercial License,\nas applicable. <\/em><\/li><\/ol>\n","protected":false},"excerpt":{"rendered":"

    The ContractSamples.py sheet from our Python Testbed sample will help you learn the syntax needed to define contracts in algo trading systems.<\/p>\n","protected":false},"author":90,"featured_media":11822,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[340,343,349,338],"tags":[851,2568,865,575,1013,595],"contributors-categories":[13576],"class_list":{"0":"post-11808","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"has-post-thumbnail","7":"category-api-development","8":"category-programing-languages","9":"category-python-development","10":"category-ibkr-quant-news","11":"tag-algo-trading","12":"tag-contractsamples-py","13":"tag-github","14":"tag-ibkr-api","15":"tag-program-py","16":"tag-python","17":"contributors-categories-interactive-brokers"},"pp_statuses_selecting_workflow":false,"pp_workflow_action":"current","pp_status_selection":"publish","acf":[],"yoast_head":"\nIBKR Python API – Four Key Syntax Attributes to Define a Contract<\/title>\n<meta name=\"description\" content=\"Get started with IBKR Python API by coding these four key syntax attributes, used to define a contract in algo trading systems.\" \/>\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\/posts\/11808\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"IBKR Python API - Four Key Syntax Attributes to Define a Contract\" \/>\n<meta property=\"og:description\" content=\"Get started with IBKR Python API by coding these four key syntax attributes, used to define a contract in algo trading systems.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.interactivebrokers.com\/campus\/ibkr-quant-news\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\/\" \/>\n<meta property=\"og:site_name\" content=\"IBKR Campus US\" \/>\n<meta property=\"article:published_time\" content=\"2019-07-25T16:28:34+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2023-01-20T20:09:22+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.interactivebrokers.com\/campus\/wp-content\/uploads\/sites\/2\/2019\/07\/Python-Attributes.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"657\" \/>\n\t<meta property=\"og:image:height\" content=\"400\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"IBKR Quant\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"IBKR Quant\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" 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\": \"NewsArticle\",\n\t \"@id\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/ibkr-quant-news\\\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\\\/#article\",\n\t \"isPartOf\": {\n\t \"@id\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/ibkr-quant-news\\\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\\\/\"\n\t },\n\t \"author\": {\n\t \"name\": \"IBKR Quant\",\n\t \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/#\\\/schema\\\/person\\\/8279da2435a7846d83a358a25c49b8f4\"\n\t },\n\t \"headline\": \"IBKR Python API – Four Key Syntax Attributes to Define a Contract\",\n\t \"datePublished\": \"2019-07-25T16:28:34+00:00\",\n\t \"dateModified\": \"2023-01-20T20:09:22+00:00\",\n\t \"mainEntityOfPage\": {\n\t \"@id\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/ibkr-quant-news\\\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\\\/\"\n\t },\n\t \"wordCount\": 127,\n\t \"publisher\": {\n\t \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/#organization\"\n\t },\n\t \"image\": {\n\t \"@id\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/ibkr-quant-news\\\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\\\/#primaryimage\"\n\t },\n\t \"thumbnailUrl\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/wp-content\\\/uploads\\\/sites\\\/2\\\/2019\\\/07\\\/Python-Attributes.jpg\",\n\t \"keywords\": [\n\t \"Algo Trading\",\n\t \"ContractSamples.py\",\n\t \"GitHub\",\n\t \"IBKR API\",\n\t \"Program.py\",\n\t \"Python\"\n\t ],\n\t \"articleSection\": [\n\t \"IBKR API Development\",\n\t \"Programming Languages\",\n\t \"Python Development\",\n\t \"Quant\"\n\t ],\n\t \"inLanguage\": \"en-US\"\n\t },\n\t {\n\t \"@type\": \"WebPage\",\n\t \"@id\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/ibkr-quant-news\\\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\\\/\",\n\t \"url\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/ibkr-quant-news\\\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\\\/\",\n\t \"name\": \"IBKR Python API - Four Key Syntax Attributes to Define a Contract\",\n\t \"isPartOf\": {\n\t \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/#website\"\n\t },\n\t \"primaryImageOfPage\": {\n\t \"@id\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/ibkr-quant-news\\\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\\\/#primaryimage\"\n\t },\n\t \"image\": {\n\t \"@id\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/ibkr-quant-news\\\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\\\/#primaryimage\"\n\t },\n\t \"thumbnailUrl\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/wp-content\\\/uploads\\\/sites\\\/2\\\/2019\\\/07\\\/Python-Attributes.jpg\",\n\t \"datePublished\": \"2019-07-25T16:28:34+00:00\",\n\t \"dateModified\": \"2023-01-20T20:09:22+00:00\",\n\t \"description\": \"Get started with IBKR Python API by coding these four key syntax attributes, used to define a contract in algo trading systems.\",\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-quant-news\\\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\\\/\"\n\t ]\n\t }\n\t ]\n\t },\n\t {\n\t \"@type\": \"ImageObject\",\n\t \"inLanguage\": \"en-US\",\n\t \"@id\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/ibkr-quant-news\\\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\\\/#primaryimage\",\n\t \"url\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/wp-content\\\/uploads\\\/sites\\\/2\\\/2019\\\/07\\\/Python-Attributes.jpg\",\n\t \"contentUrl\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/wp-content\\\/uploads\\\/sites\\\/2\\\/2019\\\/07\\\/Python-Attributes.jpg\",\n\t \"width\": 657,\n\t \"height\": 400,\n\t \"caption\": \"IBKR Python API - Four Key Syntax Attributes to Define a Contract\"\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 \"@type\": \"Person\",\n\t \"@id\": \"https:\\\/\\\/ibkrcampus.com\\\/campus\\\/#\\\/schema\\\/person\\\/8279da2435a7846d83a358a25c49b8f4\",\n\t \"name\": \"IBKR Quant\",\n\t \"url\": \"https:\\\/\\\/www.interactivebrokers.com\\\/campus\\\/author\\\/ibkrquant\\\/\"\n\t }\n\t ]\n\t}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"IBKR Python API – Four Key Syntax Attributes to Define a Contract","description":"Get started with IBKR Python API by coding these four key syntax attributes, used to define a contract in algo trading systems.","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\/posts\/11808\/","og_locale":"en_US","og_type":"article","og_title":"IBKR Python API - Four Key Syntax Attributes to Define a Contract","og_description":"Get started with IBKR Python API by coding these four key syntax attributes, used to define a contract in algo trading systems.","og_url":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-quant-news\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\/","og_site_name":"IBKR Campus US","article_published_time":"2019-07-25T16:28:34+00:00","article_modified_time":"2023-01-20T20:09:22+00:00","og_image":[{"width":657,"height":400,"url":"https:\/\/www.interactivebrokers.com\/campus\/wp-content\/uploads\/sites\/2\/2019\/07\/Python-Attributes.jpg","type":"image\/jpeg"}],"author":"IBKR Quant","twitter_card":"summary_large_image","twitter_misc":{"Written by":"IBKR Quant","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"NewsArticle","@id":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-quant-news\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\/#article","isPartOf":{"@id":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-quant-news\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\/"},"author":{"name":"IBKR Quant","@id":"https:\/\/ibkrcampus.com\/campus\/#\/schema\/person\/8279da2435a7846d83a358a25c49b8f4"},"headline":"IBKR Python API – Four Key Syntax Attributes to Define a Contract","datePublished":"2019-07-25T16:28:34+00:00","dateModified":"2023-01-20T20:09:22+00:00","mainEntityOfPage":{"@id":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-quant-news\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\/"},"wordCount":127,"publisher":{"@id":"https:\/\/ibkrcampus.com\/campus\/#organization"},"image":{"@id":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-quant-news\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\/#primaryimage"},"thumbnailUrl":"https:\/\/www.interactivebrokers.com\/campus\/wp-content\/uploads\/sites\/2\/2019\/07\/Python-Attributes.jpg","keywords":["Algo Trading","ContractSamples.py","GitHub","IBKR API","Program.py","Python"],"articleSection":["IBKR API Development","Programming Languages","Python Development","Quant"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-quant-news\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\/","url":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-quant-news\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\/","name":"IBKR Python API - Four Key Syntax Attributes to Define a Contract","isPartOf":{"@id":"https:\/\/ibkrcampus.com\/campus\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-quant-news\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\/#primaryimage"},"image":{"@id":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-quant-news\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\/#primaryimage"},"thumbnailUrl":"https:\/\/www.interactivebrokers.com\/campus\/wp-content\/uploads\/sites\/2\/2019\/07\/Python-Attributes.jpg","datePublished":"2019-07-25T16:28:34+00:00","dateModified":"2023-01-20T20:09:22+00:00","description":"Get started with IBKR Python API by coding these four key syntax attributes, used to define a contract in algo trading systems.","inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.interactivebrokers.com\/campus\/ibkr-quant-news\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.interactivebrokers.com\/campus\/ibkr-quant-news\/ibkr-python-api-four-key-syntax-attributes-to-define-a-contract\/#primaryimage","url":"https:\/\/www.interactivebrokers.com\/campus\/wp-content\/uploads\/sites\/2\/2019\/07\/Python-Attributes.jpg","contentUrl":"https:\/\/www.interactivebrokers.com\/campus\/wp-content\/uploads\/sites\/2\/2019\/07\/Python-Attributes.jpg","width":657,"height":400,"caption":"IBKR Python API - Four Key Syntax Attributes to Define a Contract"},{"@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\/"},{"@type":"Person","@id":"https:\/\/ibkrcampus.com\/campus\/#\/schema\/person\/8279da2435a7846d83a358a25c49b8f4","name":"IBKR Quant","url":"https:\/\/www.interactivebrokers.com\/campus\/author\/ibkrquant\/"}]}},"jetpack_featured_media_url":"https:\/\/www.interactivebrokers.com\/campus\/wp-content\/uploads\/sites\/2\/2019\/07\/Python-Attributes.jpg","_links":{"self":[{"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/posts\/11808","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/users\/90"}],"replies":[{"embeddable":true,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/comments?post=11808"}],"version-history":[{"count":0,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/posts\/11808\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/media\/11822"}],"wp:attachment":[{"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/media?parent=11808"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/categories?post=11808"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/tags?post=11808"},{"taxonomy":"contributors-categories","embeddable":true,"href":"https:\/\/ibkrcampus.com\/campus\/wp-json\/wp\/v2\/contributors-categories?post=11808"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}