Utility code for interacting with the Upvest Investment API, mainly HTTP Message Signatures
Project description
Upvest Investment API
This Python package is NOT a fully fledged API client.
So far, it implements the parts of the HTTP Message Signatures, draft version 15 functionality which are required to interact with the Upvest Investment API.
Next to a generic implementation, this is also provided as a custom authentication mechanism for the requests
Python package when you install this package with the requests-auth
extra enabled like so: pip install upvest-investment-api[requests-auth]
For examples how to use this, please refer to Upvest's Python code examples.
Required dependency
This Python package relies on the cryptography
package to do the heavy lifting for HTTP Message Signatures.
Optional dependencies / Package extras
This Python package uses optional dependencies to give you control over which additional dependencies get installed when using it:
- The package extra
requests-auth
installs therequests
package which is required to provide therequests
custom authentication mechanism mentioned above. - The package extra
file-download
installs therequests
package and thePGPy
package which both are required to enable downloading files from the Upvest Investment API. See how to use it in this MiFIR report file download code example. - The package extra
env-settings
installs theenvirons
package which is used to load all settings and the access credentials for the Upvest Investment API from environment variables.
You can specify multiple extras at the same time as a comma-separated list like so: pip install upvest-investment-api[requests-auth,env-settings,file-download]
, optionally pinning the version like so: pip install upvest-investment-api[requests-auth,env-settings,file-download]==0.0.1
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file upvest_investment_api-0.0.1.tar.gz
.
File metadata
- Download URL: upvest_investment_api-0.0.1.tar.gz
- Upload date:
- Size: 15.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4886a524d811d081bc21f0810936aba35c515e24c5cb21240b7230073358304c |
|
MD5 | 40f2aa214a0ea4785b4da8b65cff4b73 |
|
BLAKE2b-256 | 3dcc43fd5cf34af6cddd302884394872a3fd74b5944cb6523273e8bab79f0e0a |
File details
Details for the file upvest_investment_api-0.0.1-py3-none-any.whl
.
File metadata
- Download URL: upvest_investment_api-0.0.1-py3-none-any.whl
- Upload date:
- Size: 22.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92333ceb34eb37f1615ad618504b05ce49e0a2c6354e423aec4ebe103015d485 |
|
MD5 | c63469e48383ed33c4a58151808b3a1d |
|
BLAKE2b-256 | 26fced8dbd4b5701546f4f4cdf38d20f1b82a80ab5f5c8a5cea20bc4210a3708 |