# eikon_api_wrapper
Easier and more reliable usage of the Eikon data terminal when querying company or bond data.
The API allows to create tables like in the Eikon Screener APP, but with arbitrary amount of rows and columns.
## Usage
1. Clone or download this repository.
2. To use the Eikon API, create a file called `eikon_app_key.txt` with a valid eikon app key in the root directory of your local clone.
More information for getting this Eikon App Key is available [here](https://developers.refinitiv.com/en/api-catalog/eikon/eikon-data-api/quick-start).
2. Start the Thomson Reuters Eikon Terminal in Front End and login (for that, you have to sit at a computer that has access Eikon).
3. Run `sample_extraction.py` to retrieve a sample data extract from Eikon.
4. The results will be stored locally in a subfolder called `data`.
You can imitate the sample functions for custom extractions. Check their definitions in the `functions.py` script. To find the column names you need for your specific task, you can use the Eikon front end. Just browse for a sample company or bond and find a sample value you are interested in.
Then hover over the question mark to find its API Name, which you can then use in your custom function like in the sample functions.
Raw data
{
"_id": null,
"home_page": null,
"name": "eikon_api_wrapper",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "eikon, api, wrapper, data, extracts",
"author": "Marcus Rockel",
"author_email": "marcus.rockel@finance.uni-freiburg.de",
"download_url": "https://files.pythonhosted.org/packages/1a/8d/93155d94fb0fe46839beae513514327bea8effc7a43fad414d5269caa130/eikon_api_wrapper-0.0.5.tar.gz",
"platform": null,
"description": "# eikon_api_wrapper\nEasier and more reliable usage of the Eikon data terminal when querying company or bond data.\nThe API allows to create tables like in the Eikon Screener APP, but with arbitrary amount of rows and columns.\n\n## Usage\n1. Clone or download this repository.\n2. To use the Eikon API, create a file called `eikon_app_key.txt` with a valid eikon app key in the root directory of your local clone.\nMore information for getting this Eikon App Key is available [here](https://developers.refinitiv.com/en/api-catalog/eikon/eikon-data-api/quick-start).\n2. Start the Thomson Reuters Eikon Terminal in Front End and login (for that, you have to sit at a computer that has access Eikon).\n3. Run `sample_extraction.py` to retrieve a sample data extract from Eikon.\n4. The results will be stored locally in a subfolder called `data`.\n\nYou can imitate the sample functions for custom extractions. Check their definitions in the `functions.py` script. To find the column names you need for your specific task, you can use the Eikon front end. Just browse for a sample company or bond and find a sample value you are interested in.\n\n\n\nThen hover over the question mark to find its API Name, which you can then use in your custom function like in the sample functions.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Enables effective and resilient Eikon data extracts.",
"version": "0.0.5",
"project_urls": null,
"split_keywords": [
"eikon",
" api",
" wrapper",
" data",
" extracts"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d564ca4667a669dadc54dc2718decc9c6908d49a7b432d57d5bf5a780cef05a7",
"md5": "d1f79c37fefe523ff14b78178ed6127e",
"sha256": "9eed2a30df44d2ac381adda6a17dd554d16b59eb9002f066dd473b45ef523456"
},
"downloads": -1,
"filename": "eikon_api_wrapper-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d1f79c37fefe523ff14b78178ed6127e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 36326,
"upload_time": "2024-04-03T21:25:47",
"upload_time_iso_8601": "2024-04-03T21:25:47.083252Z",
"url": "https://files.pythonhosted.org/packages/d5/64/ca4667a669dadc54dc2718decc9c6908d49a7b432d57d5bf5a780cef05a7/eikon_api_wrapper-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1a8d93155d94fb0fe46839beae513514327bea8effc7a43fad414d5269caa130",
"md5": "afd28317b073234d7e7269f2af5338f5",
"sha256": "111c0a789d1a20266c357696e50a2dcb50ad173add2ff9e5642d570e631ea030"
},
"downloads": -1,
"filename": "eikon_api_wrapper-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "afd28317b073234d7e7269f2af5338f5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 35693,
"upload_time": "2024-04-03T21:25:52",
"upload_time_iso_8601": "2024-04-03T21:25:52.766494Z",
"url": "https://files.pythonhosted.org/packages/1a/8d/93155d94fb0fe46839beae513514327bea8effc7a43fad414d5269caa130/eikon_api_wrapper-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-03 21:25:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "eikon_api_wrapper"
}
JSON