{"id":13449710,"url":"https://github.com/quandl/quandl-python","last_synced_at":"2025-10-20T16:07:13.352Z","repository":{"id":7626622,"uuid":"8986011","full_name":"quandl/quandl-python","owner":"quandl","description":null,"archived":true,"fork":false,"pushed_at":"2022-04-29T15:50:15.000Z","size":284,"stargazers_count":1381,"open_issues_count":4,"forks_count":338,"subscribers_count":131,"default_branch":"master","last_synced_at":"2024-09-27T04:42:39.583Z","etag":null,"topics":["api-client","data-frame","dataset","python","quandl","retrieve-data"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quandl.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-03-24T12:53:23.000Z","updated_at":"2024-09-23T10:50:28.000Z","dependencies_parsed_at":"2022-09-26T17:41:20.302Z","dependency_job_id":null,"html_url":"https://github.com/quandl/quandl-python","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quandl%2Fquandl-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quandl%2Fquandl-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quandl%2Fquandl-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quandl%2Fquandl-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quandl","download_url":"https://codeload.github.com/quandl/quandl-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234583683,"owners_count":18856280,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-client","data-frame","dataset","python","quandl","retrieve-data"],"created_at":"2024-07-31T06:00:52.040Z","updated_at":"2025-09-29T02:32:17.093Z","avatar_url":"https://github.com/quandl.png","language":"Python","funding_links":[],"categories":["Data Sources","Python"],"sub_categories":["General"],"readme":"# Quandl is now Nasdaq Data Link\n\nWe are excited to announce that the Quandl technology platform is being transformed into a new global solution: Nasdaq Data Link. This development is the first step toward realizing a single, unified data discovery and delivery experience with Nasdaq.\n\nIn accordance with this change Nasdaq Data Link has released a new version of this Python Client.  Moving forward, we are encouraging user to use this [VERSION](https://github.com/Nasdaq/data-link-python) in order to take advantage of new features.\n\n# Quandl Python Client\n[![Build Status](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiZUtvUFNYREloNE4vV0xWWEUxVS81S0toZjdQbzQrWXhQZ1BUbE1mZ1FMVXdSZXQ2K1ZLQ1ducmtqYTVWa2xBZXhRMWVGemVKWitzVm5MNXI4cGZYb21RPSIsIml2UGFyYW1ldGVyU3BlYyI6Im0vdUljcjBjdmpGVU9XdXUiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D\u0026branch=master)]()\n[![PyPI version](https://badge.fury.io/py/Quandl.svg)](https://badge.fury.io/py/Quandl)\n\nThis is the official documentation for Quandl's Python Package. The package can be used to interact with the latest version of the [Quandl RESTful API](https://www.quandl.com/docs/api). This package is compatible with python v2.7.x and v3.x+.\n\n## Deprecation of old package\n\nPlease see this readme for more information and upgrade instructions: [2.x series transition notes](./2_SERIES_UPGRADE.md)\n\n## Installation\n\nThe installation process varies depending on your python version and system used. However in most cases the following should work:\n\n```shell\npip install quandl\n```\n\nAlternatively on some systems python3 may use a different pip executable and may need to be installed via an alternate pip command. For example:\n\n```shell\npip3 install quandl\n```\n\n## Configuration\n\n| Option | Explanation | Example |\n|---|---|---|\n| api_key | Your access key | `tEsTkEy123456789` | Used to identify who you are and provide full access. |\n| use_retries | Whether API calls which return statuses in `retry_status_codes` should be automatically retried | True\n| number_of_retries | Maximum number of retries that should be attempted. Only used if `use_retries` is True | 5\n| max_wait_between_retries | Maximum amount of time in seconds that should be waited before attempting a retry. Only used if `use_retries` is True | 8\n| retry_backoff_factor | Determines the amount of time in seconds that should be waited before attempting another retry. Note that this factor is exponential so a `retry_backoff_factor` of 0.5 will cause waits of [0.5, 1, 2, 4, etc]. Only used if `use_retries` is True | 0.5\n| retry_status_codes | A list of HTTP status codes which will trigger a retry to occur. Only used if `use_retries` is True| [429, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511]\n\n```python\nimport quandl\nquandl.ApiConfig.api_key = 'tEsTkEy123456789'\n```\nBy default, SSL verification is enabled. To bypass SSL verification\n```python\nquandl.ApiConfig.verify_ssl = False\n```\n\n### Local API Key file\nSave local key to `$HOME/.quandl_apikey` file\n```\nimport quandl\nquandl.save_key(\"supersecret\")\nprint(quandl.ApiConfig.api_key)\n```\n\nLoad the API Key without exposing the key in the script or notebook\n```\nimport quandl\nquandl.read_key()\nprint(quandl.ApiConfig.api_key)\n```\n\nSet a custom location for the API key file, e.g. store the externally outside a docker container\n```\nimport quandl\nquandl.save_key(\"ourcorporateapikey\", filename=\"/srv/data/somecontainer/.corporatequandlapikey\")\n```\nand call within the docker container with mount point at `/data`\n```\nimport quandl\nquandl.read_key(filepath=\"/data/.corporatequandlapikey\")\n```\n\n\n## Retrieving Data\n\nThere are two methods for retrieving data in Python: the Quick method and the Detailed method. The latter is more suitable to application programming. Both methods work with Quandl's two types of data structures: time-series (dataset) data and non-time series (datatable).\n\nThe following quick call can be used to retrieve a dataset:\n\n```python\nimport quandl\ndata = quandl.get('NSE/OIL')\n```\n\nThis example finds all data points for the dataset `NSE/OIL` and stores them in a pandas dataframe. You can then view the dataframe with data.head().\n\nA similar quick call can be used to retrieve a datatable:\n\n```python\nimport quandl\ndata = quandl.get_table('ZACKS/FC', ticker='AAPL')\n```\n\nThis example retrieves all rows for `ZACKS/FC` where `ticker='AAPL'` and stores them in a pandas dataframe. Similarly you can then view the dataframe with data.head().\n\nNote that in both examples if an `api_key` has not been set you may receive limited or sample data. You can find more details on these quick calls and others in our [Quick Method Guide](./FOR_ANALYSTS.md).\n\n### Logging\n\nCurrently, Quandl debug logging is limited in scope.  However, to enable debug\nlogs you can use the following snippet.\n\n```python\nimport quandl\nimport logging\n\nlogging.basicConfig()\n# logging.getLogger().setLevel(logging.DEBUG)  # optionally set level for\neverything.  Useful to see dependency debug info as well.\n\nquandl_log = logging.getLogger(\"quandl\")\nquandl_log.setLevel(logging.DEBUG)\n```\n\n\n### Detailed Usage\n\nOur API can provide more than just data. It can also be used to search and provide metadata or to programmatically retrieve data. For these more advanced techniques please follow our [Detailed Method Guide](./FOR_DEVELOPERS.md).\n\n## Local Development\n\n### Setup\n\nIf you wish to work on local development please clone/fork the git repo and use `pip install -r requirements.txt` to setup the project.\n\n### Testing\n\nWe recommend the following tools for testing any changes:\n\n* [nose](https://nose.readthedocs.org/en/latest/) for running tests.\n* [tox](https://pypi.python.org/pypi/tox) for testing against multiple versions of python.\n* [flake8](https://flake8.readthedocs.org/en/latest/) for syntax checking.\n* [virtualenv](https://virtualenv.pypa.io/en/latest/) for use with tox virtualization.\n\nThe following are instructions for running our tests:\n\n1. Make sure a version of python 2.7 or python 3.x is installed locally in your system. To avoid permission issues on OSX we recommend installing the packages from: https://www.python.org/downloads/\n2. Install `virtualenv` and `tox` using:\n    `pip install tox virtualenv`\n3. Run following command (you may notice slow performance the first time):\n    `python setup.py install`\n4. Run the following command to test the plugin in all versions of python we support:\n    `tox`\n\nOnce you have all required packages installed, you can run tests locally with:\n\nRunning all tests locally\n\n```python\npython -W always setup.py -q test\n```\n\nRunning an individual test\n\n```python\npython -m unittest test.[test file name].[class name].[individual test name]`\n```\n\nExample:\n\n```python\npython -m unittest -v test.test_datatable.ExportDataTableTest.test_download_get_file_info\n```\n\n## Recommended Usage\n\nWe would suggest downloading the data in raw format in the highest frequency possible and performing any data manipulation\nin pandas itself.\n\nSee [this link](http://pandas.pydata.org/pandas-docs/dev/timeseries.html) for more information about timeseries in pandas.\n\n## Release the Package\n\nTo release the package, you can follow the instructions on this [page](https://packaging.python.org/tutorials/packaging-projects/#packaging-python-projects)\n\n## Additional Links\n\n* [Quandl](https://www.quandl.com)\n* [Quandl Tools](https://www.quandl.com/tools/api)\n* [API Docs](https://www.quandl.com/docs/api)\n\n## License\n\n[MIT License](http://opensource.org/licenses/MIT)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquandl%2Fquandl-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquandl%2Fquandl-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquandl%2Fquandl-python/lists"}