Skip to content

flash420/newton-api-wrapper

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

(WIP) newton-api-wrapper 🍎

This project contains the code of a wrapper for Newton Pro API made in python. Newton is Canada's first no-fee cryptocurrency brokerage. Here's the documentation of the official Newton Pro API. I'm using tox to run tests.

Requirements

The client_id and the secret_key are required as parameters in the Newton class for it to work (for private requests).

  • Client ID : Is your unique client identifier. You can find this under the API Access settings in the Newton web app.
  • Client Secret Key : Is your secret key that can be found in the API Access settings in the Newton web app.

Usage

import os

from newton_wrapper import Newton

newton = Newton(os.getenv("NEWTON_API_CLIENT_ID"),
                os.getenv("NEWTON_API_SECRET_KEY"))

# Client id and secret key is optional in the constructor and can be set after with the set_client_id(CLIENT_ID) and set_secret_key(SECRET_KEY) methods
# newton.set_client_id(os.getenv("NEWTON_API_CLIENT_ID"))
# newton.set_secret_key(os.getenv("NEWTON_API_SECRET_KEY"))

# PUBLIC

# Get the maker and taker fees that will be applied to your order.
print("Fees:", newton.get_fees())

# To get the health status of the Newton API.
print("Server status:", newton.healthcheck())

# Get the maximum amount possible to create an order per asset.
print("Maximum trade amounts:", newton.get_max_trade())

# Get the minimum amount needed to create an order per asset.
print("Minimum trade amounts:", newton.get_min_trade())

# Receive the list of supported symbols.
print("Symbols:", newton.get_symbols())

# Get the tick size for the different symbols.
print("Symbols tick sizes:", newton.get_tick_sizes())


# PRIVATE

# Get the history of actions you made.
print("Account actions:", newton.get_actions())

# Get the balances of every asset.
print("Account balances:", newton.get_balances())

# Get the history of all your orders.
print("Account order history:", newton.get_order_history())

# Get the list of all your open orders.
print("Account open orders:", newton.get_open_orders())

Potential Additions

  • Add typing (for enums and parameters)
  • Add pre-commit hook for formatting and linting (flake8, black, isort)
  • Add parameters validation before request
  • Add enums for some parameters (ex: DEPOSIT,WITHDRAWAL,TRANSACT or IOC,GTC,GTD)
  • Improve new_order method (lack of documentation atm)
  • Add tests (hehe)
  • Add status code to return values

About

(WIP) Wrapper for the Netwon Pro API 🍎 https://www.newton.co/

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%