# bulkdownload
Utility script to retrieve bulk downloads
## Environment Variables
Env Var | Description | Required
-- | -- | --
NDL_APIKEY | Data Link api key. Used for all requests to perform bulk download. | Yes
NDL_HOSTNAME | Alternative hostname to retrieve files. | No
## Install
[Create a venv](https://docs.python.org/3/library/venv.html) or pyenv if you
like and activate.
```shell
pip install ndlbulkdownload
```
## Usage
The '--param' accepts key/value pairs as you would define query parameters.
For any given product documentation, define the key as necessary.
Note, for collections, you can specify multiple of the same key. Use RFC
brackets [] for lists of a given key. See examples below.
```shell
bulkdownload --help
usage: bulkdownload [-h] --code VC/TC [--param key value] [--debug]
[--verbose] [--skip-proxy] [--skip-ssl-verify]
[--redirect | --no-redirect] [--workers W]
[--host hostname] [--version]
Bulk Download from Data Link.
options:
-h, --help show this help message and exit
--code VC/TC The vendor_code/table_code you are trying to download.
Example: FOO/BAR
--param key value Add query param key/value pair
--debug Increase log level to DEBUG
--verbose Show logging output
--skip-proxy Ignore proxy environment variables
--skip-ssl-verify Do not verify SSL (not recommended in most situations)
--redirect, --no-redirect
Request redirect to files (default: true)
--workers W Total parallel workers (default: min(32, os.cpu_count()))
--host hostname Define an alternative hostname
--version show program's version number and exit
```
## Examples
```shell
# download data on a particular date:
bulkdownload --code FOO/BAR --param date.eq 2024-09-01
# download multiple tickers between a given date [start, end)
bulkdownload --code FOO/BAR --param 'symbols.in[]' MSFT --param 'symbols.in[]' AAPL --param date.gte 2024-01-01 --param date.lt 2024-04-01
```
Raw data
{
"_id": null,
"home_page": null,
"name": "ndlbulkdownload",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Nasdaq Data Link Development Team <connect@data.nasdaq.com>",
"keywords": "cli, console, data, datalink, economic, financial, nasdaq, nasdaq data link, terminal",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/72/cc/7797fda43ab4152a940157d6207cd66097b407db72139c99d1d428adc0ce/ndlbulkdownload-0.1.0.tar.gz",
"platform": null,
"description": "# bulkdownload\n\nUtility script to retrieve bulk downloads\n\n## Environment Variables\n\nEnv Var | Description | Required\n-- | -- | --\nNDL_APIKEY | Data Link api key. Used for all requests to perform bulk download. | Yes\nNDL_HOSTNAME | Alternative hostname to retrieve files. | No\n\n## Install\n\n[Create a venv](https://docs.python.org/3/library/venv.html) or pyenv if you\nlike and activate.\n\n```shell\npip install ndlbulkdownload\n```\n\n## Usage\n\nThe '--param' accepts key/value pairs as you would define query parameters.\nFor any given product documentation, define the key as necessary.\n\nNote, for collections, you can specify multiple of the same key. Use RFC\nbrackets [] for lists of a given key. See examples below.\n\n```shell\nbulkdownload --help\n\nusage: bulkdownload [-h] --code VC/TC [--param key value] [--debug]\n [--verbose] [--skip-proxy] [--skip-ssl-verify]\n [--redirect | --no-redirect] [--workers W]\n [--host hostname] [--version]\n\nBulk Download from Data Link.\n\noptions:\n -h, --help show this help message and exit\n --code VC/TC The vendor_code/table_code you are trying to download.\n Example: FOO/BAR\n --param key value Add query param key/value pair\n --debug Increase log level to DEBUG\n --verbose Show logging output\n --skip-proxy Ignore proxy environment variables\n --skip-ssl-verify Do not verify SSL (not recommended in most situations)\n --redirect, --no-redirect\n Request redirect to files (default: true)\n --workers W Total parallel workers (default: min(32, os.cpu_count()))\n --host hostname Define an alternative hostname\n --version show program's version number and exit\n```\n\n## Examples\n\n```shell\n# download data on a particular date:\nbulkdownload --code FOO/BAR --param date.eq 2024-09-01\n\n# download multiple tickers between a given date [start, end)\nbulkdownload --code FOO/BAR --param 'symbols.in[]' MSFT --param 'symbols.in[]' AAPL --param date.gte 2024-01-01 --param date.lt 2024-04-01\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Data Link CLI Bulk Download Utility",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/nasdaq/ndlbulkdownload",
"Issues": "https://github.com/nasdaq/ndlbulkdownload/issues"
},
"split_keywords": [
"cli",
" console",
" data",
" datalink",
" economic",
" financial",
" nasdaq",
" nasdaq data link",
" terminal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bd7e7251dc336fcd8b6252a2a99a8863a7eaa259dee83132dfc583e837649f25",
"md5": "b05c8557783fa66e8466bf8bf1abe378",
"sha256": "9568fbca89d758c22446f888a74bed8ef2813e26c00d87b44d3306e9da6aa8a3"
},
"downloads": -1,
"filename": "ndlbulkdownload-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b05c8557783fa66e8466bf8bf1abe378",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 7364,
"upload_time": "2024-09-27T16:57:40",
"upload_time_iso_8601": "2024-09-27T16:57:40.276075Z",
"url": "https://files.pythonhosted.org/packages/bd/7e/7251dc336fcd8b6252a2a99a8863a7eaa259dee83132dfc583e837649f25/ndlbulkdownload-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "72cc7797fda43ab4152a940157d6207cd66097b407db72139c99d1d428adc0ce",
"md5": "b058c40f157c35465481eea6f02e5785",
"sha256": "36e1b0e5eaa84cd808736aaea3f720e54e343e14ab66c1260eb56a2acb2d83f6"
},
"downloads": -1,
"filename": "ndlbulkdownload-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "b058c40f157c35465481eea6f02e5785",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5639,
"upload_time": "2024-09-27T16:57:41",
"upload_time_iso_8601": "2024-09-27T16:57:41.855387Z",
"url": "https://files.pythonhosted.org/packages/72/cc/7797fda43ab4152a940157d6207cd66097b407db72139c99d1d428adc0ce/ndlbulkdownload-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-27 16:57:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nasdaq",
"github_project": "ndlbulkdownload",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "ndlbulkdownload"
}
JSON
