https://github.com/dpguthrie/brokermint
Python interface to the Brokermint API
https://github.com/dpguthrie/brokermint
Last synced: 20 days ago
JSON representation
Python interface to the Brokermint API
- Host: GitHub
- URL: https://github.com/dpguthrie/brokermint
- Owner: dpguthrie
- License: mit
- Created: 2020-11-20T23:01:16.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-12-08T21:41:40.000Z (over 5 years ago)
- Last Synced: 2026-01-04T04:24:09.799Z (6 months ago)
- Language: Python
- Size: 36.1 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Python interface to the Brokermint API
---
**Documentation**: https://brokermint.dpguthrie.com
**Source Code**: https://github.com/dpguthrie/brokermint
**Brokermint API Documentation**: https://brokermint.com/api/
---
## Overview
**brokermint** is a python interface to data stored in Brokermint.
The interface allows access to data on Brokermint through the `Client` class:
However, the user **must** supply an `api_key` to access or manipulate any data. The user can supply the `api_key` when instantiating the `Client` class:
```python
import brokermint as bm
bmc = bm.Client("my_fake_api_key")
```
Or, you can set the environment variable `BM_API_KEY` and call the `Client` class with no arguments: `bm.Client()`
### Linux / MacOS
```bash
export BM_API_KEY=my_fake_api_key
```
### Windows
```bash
set BM_API_KEY=my_fake_api_key
```
_Note: This environment variable is only available in the current process._
See this link for adding an environment variable that exists outside of this process: https://docs.oracle.com/en/database/oracle/r-enterprise/1.5.1/oread/creating-and-modifying-environment-variables-on-windows.html*
## Requirements
Python 3.6+
- [Requests](https://requests.readthedocs.io/en/master/) - The elegant and simple HTTP library for Python, built for human beings.
## Installation
```
pip install brokermint
```
## Example
```python
import brokermint as bm
bmc = bm.Client(api_key="my_fake_api_key")
# Get Transactions - defaults to 1,000
data = bmc.list_transactions()
# Get Transactions, limit to 5
data = bmc.list_transactions(count=5)
```
## License
This project is licensed under the terms of the MIT license.