coinsbit-client
v1.0.5
Published
A client for coinsbit writen in nodejs
Downloads
9
Readme
Coinsbit-Client
Table of Contents
- Coinsbit-Client Description
- API Documentation
- Getting Started
- Functions
- Running the Tests
- Examples
- Contributing
1. Coinsbit-Client Description
The Coinsbit-client API Library provides a convenient way for developers to access the Coinsbit exchange platform and build applications that interact with it. This project includes tests for the Coinsbit-client and the tests are used to ensure that the functions are working correctly!
Install
npm install coinsbit-client
2. API Documentation
The API documentation is available at API DOCUMENTATION. The documentation includes a list of all of the available endpoints, as well as detailed information on how to use the API.
3. Getting Started
To get started with the Coinsbit-client API libary, follow these steps:
- Before using the Coinsbit-client Library, you will need to register for an API key on the Coinsbit platform.
- Sign up Coinsbit to get an API Key and an API Secret key at API KEY SIGNUP
- Read the API documentation to learn about the available endpoints and how to use the API.
- Use the Coinsbit-client library to access the necessary functions for your applications.
4. Functions
The Coinsbit-client Library provides a number of functions for interacting with the Coinsbit exchange platform. Some of the most commonly used functions include:
- getMarkets: Retrieve market data for a specific symbol
- getSymbols is used to retrieve information about the available trading symbols on the exchange (ex. ETH_BTC).
- getAccountBalance: retrieves information about the specific assest balance of an account on the exchange platform.
- getOrderHistoryList: retrieve a list of historical orders from the exchange platform.
- createNewOrder: Create a new order on the exchange
- getOrders is used to manage and retrieve information about orders on the exchange.
- cancelOrder: Cancel an existing order (using coin pairs and order ID) For a full list of available functions, please refer to the official Coinsbit-client.
5. Running the Tests
To run the tests, follow these steps:
- Clone the repository: git clone REPOSITORY URL
- Navigate to the project directory: cd coinsbit-client-master
- Install the required dependencies: npm install or yarn install
- Run the tests: npm run test or yarn test
6. Examples
Here are some examples of how to use the Coinsbit-client Library in your applications:
// Function: create a new order
async createNewOrder(request = {}) {
//const {market, side , amount, price } = request;
const response = await this.postQuery('/api/v1/order/new', request);
return response;
}
// set API key
coinsbitClient.setKey('Your API Key','Your API Secret Key');
const request = {
market : "FRL_USDT",
side : "buy",
amount : 0.1,
price : 0.6
}
const newOrder = await coinsbitClient.createNewOrder(request);
console.log(newOrder);
7. Contributing
If you want to contribute to the Coinsbit-client Library, we welcome your pull requests! Before submitting a pull request, please make sure that:
- Your changes are well-documented
- Your changes are tested and pass all existing tests
- Your changes do not break any existing functionality Thank you for your help in making the Coinsbit-client API Library better!