Skip to content

dpguthrie/brokermint

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Python interface to the Brokermint API

Coverage Package version


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:

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

export BM_API_KEY=my_fake_api_key

Windows

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 - The elegant and simple HTTP library for Python, built for human beings.

Installation

pip install brokermint

Example

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.

About

Python interface to the Brokermint API

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages