Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Simple TypeScript Bitso API Wrapper for Public and Private end points. [![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/amircp/bitso-ts/blob/master/LICENSE) ## Installation
Simple TypeScript Bitso API Wrapper for Public and Private end points.
To install Bitso-ts lib in your project:
yarn add bitso-ts
import { PublicAPI, Ticker} from 'bitso-ts';
const Public = new PublicAPI({
version:'v3',
test: false
});
Public.getAvailableBooks().then( (data) => {
console.log(data);
});
Ticker is a set of constants with cryptocurrencies available in the bitso exchange.
It is possible to specify the API version and to work with Test Sandbox API just changing the parameters to be passed (test and version).
getAvailableBooks(): Promise<IBooks[]>;
getTicker(book: Ticker): Promise<ITickers>;
getOrderBook(book: Ticker): Promise<IOrderBook[]>;
To use the private api is needed to generate your api keys directly in your bitso account.
import { PrivateAPI, Ticker} from 'bitso-ts';
const Bitso = PrivateAPI({
version: 'v3',
secret: 'b5d5e48474cbc5e6ef535def2f43e467',
key: 'VxKti2rgXE',
test: false
})
Bitso.Account.getAccountBalance().then( (data) => {
console.log(data);
});
The private API is splited into different name spaces:
Every namespace has its own set of functions. The most interesting one is Trade:
getOpenOrders(book: Ticker): Promise<[IOpenOrders]>;
cancelOrder(oids: string[]): Promise<[string]>;
placeOrder(orderPayload: IPlaceOrder): Promise<IOrderID>;
placeMarketBuyOrder(currency: string, quantity: string): Promise<IOrderID>;
placeMarketSellOrder(currency: string, quantity: string): Promise<IOrderID>;
placeLimitSellOrder({ currency, limit_price, quantity }: {
currency: Ticker;
limit_price: string;
quantity: string
}): Promise<IOrderID>;
placeLimitBuyOrder({ currency, limit_price, quantity}: {
currency: Ticker;
limit_price: number;
quantity: string
}): Promise<IOrderID>;
getUserTrades(): Promise<[IOrderTrades]>;
getOrderTrades(origin_ids: string[]): Promise<[IOrderTrades]>;
lookupOrders(oids: string[]): Promise<[IOpenOrders]>;
In the following example will place a BUY LIMIT order into the exchange.
Bitso.Trade.placeLimitBuyOrder(Ticker.BTCMXN,'1306864.89','1000').then( (data) => {
console.log(data);
});
If you want to use your own way to place orders you can use the general purpose method "placeOrder" please review bitso api documentation.
FAQs
Simple TypeScript Bitso API Wrapper for Public and Private end points. [![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/amircp/bitso-ts/blob/master/LICENSE) ## Installation
The npm package bitso-ts receives a total of 1 weekly downloads. As such, bitso-ts popularity was classified as not popular.
We found that bitso-ts demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.