cleanup

Author: areed1192

.gitignore

@@ -2,11 +2,6 @@
 __pycache__/
 *.py[cod]
 *$py.class
-configAlex.py
-clientportal.gw/
-clientportal.beta.gw/
-alex/
-config/
 
 # C extensions
 *.so
@@ -132,6 +127,13 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
-.vscode/settings.json
-curl.txt
+
+# Add files that I don't want on GitHub.
+.vscode/
 ibw/server_session.json
+.pypirc
+MANIFEST.in
+clientportal.gw/
+clientportal.beta.gw/
+alex/
+config/

README.md

@@ -55,7 +55,9 @@ The API does not require any API keys to use it, all of the authentication is ha
 
 ## Setup Installation
 
-PLACE HOLDER FOR PIP INSTALLATION
+```console
+pip install interactive-broker-python-web-api
+```
 
 ## Setup Writing Account Information
 
@@ -71,18 +73,22 @@ To create a config file using hte `configparser` module, run the script below in
 import pathlib
 from configparser import ConfigParser
 
+# Initialize a new instance of the `ConfigParser` object.
 config = ConfigParser()
 
+# Define a new section called `main`.
 config.add_section('main')
 
+# Set the values for the `main` section.
 config.set('main', 'REGULAR_ACCOUNT', 'YOUR_ACCOUNT_NUMBER')
 config.set('main', 'REGULAR_USERNAME', 'YOUR_ACCOUNT_USERNAME')
-
 config.set('main', 'PAPER_ACCOUNT', 'YOUR_ACCOUNT_NUMBER')
 config.set('main', 'PAPER_USERNAME', 'YOUR_ACCOUNT_USERNAME')
 
+# Make the `config` folder for the user.
 new_directory = pathlib.Path("config/").mkdir(parents=True, exist_ok=True)
 
+# Write the contents of the `ConfigParser` object to the `config.ini` file.
 with open('config/config.ini', 'w+') as f:
     config.write(f)
 ```
@@ -129,9 +135,15 @@ ib_client.close_session()
 
 For certain requests, in a limited fashion, it will help validate your request when possible. For example, when grabbing real-time quotes using the `market_data` endpoint, it will validate the fields you request to ensure they're valid fields for that endpoint.
 
-## Documentation and Resources
+### Endpoint Verification
+
+To use certain endpoints, you must call other endpoints before you use it. To help limit the amount of confusion for users, the library will call those endpoints for you behind the scenes so that way you don't need to worry about it.
 
-### Official API Documentation
+### Client Portal Download
+
+If the user doesn't have the clientportal gateway downloaded, then the library will download a copy it, unzip it for you, and quickly allow you to get up and running with your scripts.
+
+## Documentation and Resources
 
 - [Getting Started](https://interactivebrokers.github.io/cpwebapi/index.html#login)
 - [Endpoints](https://interactivebrokers.com/api/doc.html)
@@ -146,4 +158,4 @@ Help support this project and future projects by donating to my [Patreon Page](h
 If you'd like to watch more of my content, feel free to visit my YouTube channel [Sigma Coding](https://www.youtube.com/c/SigmaCoding).
 
 **Hire Me:**
-If you have a project, you think I can help you with feel free to reach out at [[email protected]](mailto:[email protected]?subject=[GitHub]%20Project%20Proposal) or fill out the [contract request form](https://forms.office.com/Pages/ResponsePage.aspx?id=ZwOBErInsUGliXx0Yo2VfcCSWZSwW25Es3vPV2veU0pUMUs5MUc2STkzSzVQMFNDVlI5NjJVNjREUi4u)
+If you have a project, you think I can help you with feel free to reach out at [[email protected]](mailto:[email protected]?subject=[GitHub]%20Project%20Proposal) or fill out the [contract request form](https://forms.office.com/Pages/ResponsePage.aspx?id=DQSIkWdsW0yxEjajBLZtrQAAAAAAAAAAAAa__aAmF1hURFg5ODdaVTg1TldFVUhDVjJHWlRWRzhZRy4u)

resources/clientportal.beta.gw.zip

@@ -0,0 +1,90 @@
+# Interactive Brokers Undocumented Endpoints
+
+## News Data
+
+<https://cdcdyn.interactivebrokers.com/portal.proxy/v1/portal/iserver/news/briefing>
+<https://cdcdyn.interactivebrokers.com/portal.proxy/v1/portal/iserver/news/sources>
+<https://cdcdyn.interactivebrokers.com/portal.proxy/v1/portal/iserver/news/top>
+<https://cdcdyn.interactivebrokers.com/portal.proxy/v1/portal/iserver/news/portfolio>
+<https://localhost:5000/v1/portal/fundamentals/landing/265598?widgets=news&lang=en>
+
+## Ratios
+
+<https://localhost:5000/v1/portal/fundamentals/ratio_details/265598?search_id=C|PENORM,LAST_DAY,0>
+<https://localhost:5000/v1/portal/fundamentals/ratio_details/265598?search_id=C|PR2TANBK,LAST_DAY,0,((C|TANBVPS,LFI,0))>
+<https://localhost:5000/v1/portal/fundamentals/ratio_details/265598?search_id=C|GROSMGN,TTM,0>
+
+## Tip Ranks
+
+<https://widgets.tipranks.com/api/IB/analystratings?ticker=AAPL>
+<https://widgets.tipranks.com/api/IB/news?ticker=AAPL>
+<https://widgets.tipranks.com/api/IB/prices?ticker=AAPL>
+
+## Analyst Forecast
+
+<https://localhost:5000/v1/portal/fundamentals/analyst_forecasts/265598?annual=false&all=true>
+
+## Persist
+
+<https://localhost:5000/v1/portal/fundamentals/persist/search/265598>
+
+## Fundamentals Data
+
+<https://localhost:5000/v1/portal/fundamentals/mf_lip_ratings/10753238>
+<https://localhost:5000/v1/portal/fundamentals/mf_performance_chart/10753238?chart_period=3M>
+<https://localhost:5000/v1/portal/fundamentals/mf_holdings/10753238>
+<https://localhost:5000/v1/portal/fundamentals/mf_ratios_fundamentals/10753238>
+<https://localhost:5000/v1/portal/fundamentals/mf_risks_stats/10753238?period=1Y>
+<https://localhost:5000/v1/portal/fundamentals/mf_esg/10753238>
+<https://localhost:5000/v1/portal/fundamentals/ownership/10753238>
+<https://localhost:5000/v1/portal/fundamentals/dividends/10753238>
+<https://localhost:5000/v1/portal/fundamentals/research/altavista/10753238>
+<https://localhost:5000/v1/portal/fundamentals/landing/10753238>
+
+## Metrics Reporting
+
+<https://cdcdyn.interactivebrokers.com/portal.proxy/v1/portal/metrics/report>
+
+## Scanners
+
+<https://cdcdyn.interactivebrokers.com/portal.proxy/v1/mkt/hmds/scanner>
+
+## 1-Minute Historical Data
+
+<https://localhost:5000/v1/portal/iserver/marketdata/history?conid=265598&period=2h&bar=1min>
+<https://localhost:5000/v1/portal/iserver/marketdata/history?conid=111710390&period=1m&source=m&bar=4h>
+
+## Options Contracts - Info
+
+<https://localhost:5000/v1/portal/iserver/secdef/info?conid=265598&sectype=OPT&month=MAR20&exchange=SMART&strike=297.5&right=P>
+<https://localhost:5000/v1/portal/iserver/secdef/info?conid=265598&sectype=OPT&month=MAR20&exchange=SMART&strike=297.5&right=C>
+
+## Options Contracts - Strikes
+
+<https://localhost:5000/v1/portal/iserver/secdef/strikes?conid=265598&sectype=OPT&month=MAR20&exchange=SMART>
+
+## Bonds - Info
+
+<https://localhost:5000/v1/portal/iserver/secdef/info?symbol=CL&issuerId=e1377044&sectype=BOND&filters=0:SMART,27:202109>
+
+## Params
+
+```json
+{
+  "news": {
+    "title": "News",
+    "content": []
+  },
+  "top10": {},
+  "tear_sheet": {},
+  "cumulative_performace": {},
+  "objective": {},
+  "key_profile": {},
+  "ownership": {},
+  "risk_statistics": {},
+  "dividends": {},
+  "overall_ratings": {},
+  "mf_esg": {},
+  "mf_key_ratios": {}
+}
+```

resources/clientportal.gw.zip

@@ -6,61 +6,61 @@
 
 setup(
 
-      # this will be my Library name.
-      name='interactive-broker-python-web-api',
+    # this will be my Library name.
+    name='interactive-broker-python-web-api',
 
-      # Want to make sure people know who made it.
-      author='Alex Reed',
+    # Want to make sure people know who made it.
+    author='Alex Reed',
 
-      # also an email they can use to reach out.
-      author_email='[email protected]',
+    # also an email they can use to reach out.
+    author_email='[email protected]',
 
-      # I'm in alpha development still, so a compliant version number is a1.
-      # read this as MAJOR VERSION 0, MINOR VERSION 1, MAINTENANCE VERSION 0
-      version='0.1.0',
-      description='A python client library for the Interactive Broker Web API.',
+    # I'm in alpha development still, so a compliant version number is a1.
+    # read this as MAJOR VERSION 0, MINOR VERSION 1, MAINTENANCE VERSION 0
+    version='0.1.2',
+    description='A python client library for the Interactive Broker Web API.',
 
-      # I have a long description but that will just be my README file.
-      long_description=long_description,
+    # I have a long description but that will just be my README file.
+    long_description=long_description,
 
-      # want to make sure that I specify the long description as MARKDOWN.
-      long_description_content_type="text/markdown",
+    # want to make sure that I specify the long description as MARKDOWN.
+    long_description_content_type="text/markdown",
 
-      # here is the URL you can find the code.
-      url='https://github.com/areed1192/interactive-broker-python-api',
+    # here is the URL you can find the code.
+    url='https://github.com/areed1192/interactive-broker-python-api',
 
-      # there are some dependencies to use the library, so let's list them out.
-      install_requires = [
-            'certifi>=2019.11.28',
-            'requests>=2.22.0',
-            'urllib3>=1.25.3'
-      ],
+    # there are some dependencies to use the library, so let's list them out.
+    install_requires=[
+        'certifi>=2019.11.28',
+        'requests>=2.22.0',
+        'urllib3>=1.25.3'
+    ],
 
-      # here are the packages I want "build."
-      packages=find_packages(include = ['ibw']),
+    # here are the packages I want "build."
+    packages=find_packages(include=['ibw']),
 
-      # additional classifiers that give some characteristics about the package.
-      classifiers=[
+    # additional classifiers that give some characteristics about the package.
+    classifiers=[
 
-            # I want people to know it's still early stages.
-           'Development Status :: 3 - Alpha',
+        # I want people to know it's still early stages.
+        'Development Status :: 3 - Alpha',
 
-            # My Intended audience is mostly those who understand finance.
-           'Intended Audience :: Financial and Insurance Industry',
+        # My Intended audience is mostly those who understand finance.
+        'Intended Audience :: Financial and Insurance Industry',
 
-           # My License is MIT.
-           'License :: OSI Approved :: MIT License',
+        # My License is MIT.
+        'License :: OSI Approved :: MIT License',
 
-           # I wrote the client in English
-           'Natural Language :: English',
+        # I wrote the client in English
+        'Natural Language :: English',
 
-           # The client should work on all OS.
-           'Operating System :: OS Independent',
+        # The client should work on all OS.
+        'Operating System :: OS Independent',
 
-           # The client is intendend for PYTHON 3
-           'Programming Language :: Python :: 3'
-      ],
+        # The client is intendend for PYTHON 3
+        'Programming Language :: Python :: 3'
+    ],
 
-      # you will need python 3.7 to use this libary.
-      python_requires='>3.7'
-     )
+    # you will need python 3.7 to use this libary.
+    python_requires='>3.7'
+)