Skip to content

Latest commit

 

History

History
130 lines (89 loc) · 4.99 KB

README.md

File metadata and controls

130 lines (89 loc) · 4.99 KB
Raw

BymaData API Wrapper

Unofficial wrapper for the recently released BymaData API service. Developed by Matias Gleser

Features

  • Full support for all BymaData API services.
  • Support for Python 3.6+

Installation

To install this module run:

pip install git+https://github.com/matiasgleser/bymadata-api-wrapper.git

Usage

Endpoints

Three valid endpoints are allowed (Snapshot, Delayed and EndOfDay), client must make sure to have credentials that grant access to specified endpoint.

>>> from bymadata_api_wrapper import SnapshotAPI, DelayedAPI, EndOfDayAPI

# Specify client ID and client secret key to initialize

>>> sn = SnapshotAPI(client_id="<Client ID>", client_secret="<Client Secret Key>") # Snapshot endpoint
>>> delayed = DelayedAPI(client_id="<Client ID>", client_secret="<Client Secret Key>") # Delayed endpoint
>>> eod = EndOfDayAPI(client_id="<Client ID>", client_secret="<Client Secret Key>") # EndOfDay endpoint

Available paths

For all endpoints several paths are available:

Equity data

# Equity Data
sn.equity(ticker=None, settle_period="0003", group="ACCIONES", subgroup=None, operative_form="CONTADO", currency="ARS")

Fixed Income data

# Fixed Income Data
sn.fixed_income(ticker=None, settle_period="0003", group="TITULOSPUBLICOS", market="PPT", operative_form="CONTADO", currency="ARS")

Futures data

# Futures Data
sn.futures(group="FUTMONEDAS")

Options data

# Options Data
sn.options(ticker=None, currency="ARS")

Repos data

# Repos Data
sn.repos(group="CAUCIONES")

Trading Lots data

# Trading Lots Data
sn.trading_lots(group="PXL", currency="ARS")

Loans data

# Loans Data
sn.loans(group="PRESTAMOSV", currency="ARS")

Indices data

# Indices Data
sn.indices()

Turnover data

Returns aggregate market turnover data

# Turnover Data
sn.turnover()

Intraday Operations data

Returns intraday operations for a security. A security can be determined by it´s security_id parameter or constructec by function parameters. If both are determined security_id takes preference.

# Intraday Operations Data
sn.intraday_ops(ticker = None, settle_period="0003", currency="ARS", market="CT", operative_form="C", security_id=None)

Wrapper Functions and Corresponding API Endpoints

Wrapper Function API Path Full API URI
equity() equity api-mgr.byma.com.ar/{endpoint}/equity
fixed_income() fixed_income api-mgr.byma.com.ar/{endpoint}/fixed_income
futures() futures api-mgr.byma.com.ar/{endpoint}/futures
options() options api-mgr.byma.com.ar/{endpoint}/options
repos() collateralized_repos api-mgr.byma.com.ar/{endpoint}/collateralized_repos
trading_lots() trading_lots api-mgr.byma.com.ar/{endpoint}/trading_lots
loans() loans api-mgr.byma.com.ar/{endpoint}/loans
indices() indices api-mgr.byma.com.ar/{endpoint}/indices
turnover() turnover api-mgr.byma.com.ar/{endpoint}/turnover
intraday_ops() intraday api-mgr.byma.com.ar/{endpoint}/intraday

Contributing

If you encounter a bug or would like to see new features added to bymadata-api-wrapper, please file an issue or submit a pull request.