ts-bitpin

ts-bitpin

Bitpin is an Iranian cryptocurrency exchange that allows users to buy and sell cryptocurrencies using Iranian Rial (IRR).

The purpose of this project is to provide a TypeScript client for the Bitpin API.

This project is provided as is and is not affiliated with Bitpin in any way and is not an official Bitpin project.

Installation

NPM

npm install ts-bitpin

Yarn

yarn add ts-bitpin

From Source

git clone https://github.com/amiwrpremium/ts-bitpin.git
cd ts-bitpin
npm install # or yarn

Usage

Import

import {Client} from 'ts-bitpin';

Create a Client

Simple

const client = new Client();

With Options

const client = new Client({
  apiKey: 'YOUR_API_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

Async factory

const client = await Client.create({
  apiKey: 'YOUR_API_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

License

This project is licensed under the MIT License - see the LICENSE file for details.

Disclaimer

This project is provided as is and is not affiliated with Bitpin in any way and is not an official Bitpin project.

Documentation

The documentation for this project can be found here.

Also you can find

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Changelog

The changelog for this project can be found here.

Changelog

v1.0.0 - 2024-05-18

Commits

• chore(release): 1.0.0 db43873
• feat(core): add client class and main entry point af7a051
• feat(interfaces): add response interfaces for API methods 92f360e
• feat(interfaces): add parameter interfaces for API methods ea8b617
• feat(exceptions): add custom error classes for API and request handling c02ee66
• feat(enums): add enums for order and request handling c951a90
• feat(scripts): add new version release script 0edcf11
• chore(config): add package and TypeScript configuration files 47fad12
• chore(config): add configuration and workflow files b877b1d
• feat(setup): add initial setup files 1bb9c7a