Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amiwrpremium/ts-bitpin
Unofficial "Bitpin" Exchange Typescript SDK
https://github.com/amiwrpremium/ts-bitpin
bitcoin bitpin crypto cryptocurrency exchange sdk
Last synced: about 2 months ago
JSON representation
Unofficial "Bitpin" Exchange Typescript SDK
- Host: GitHub
- URL: https://github.com/amiwrpremium/ts-bitpin
- Owner: amiwrpremium
- License: mit
- Created: 2024-05-17T23:14:06.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-11-02T20:11:52.000Z (3 months ago)
- Last Synced: 2024-12-03T08:52:41.593Z (about 2 months ago)
- Topics: bitcoin, bitpin, crypto, cryptocurrency, exchange, sdk
- Language: TypeScript
- Homepage: https://amiwrpremium.github.io/ts-bitpin/
- Size: 275 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ts-bitpin
[Bitpin](https://bitpin.ir/) 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
```bash
npm install ts-bitpin
```
### Yarn
```bash
yarn add ts-bitpin
```
### From Source
```bash
git clone https://github.com/amiwrpremium/ts-bitpin.git
cd ts-bitpin
npm install # or yarn
```
## Usage
### Import
```typescript
import { Client } from 'ts-bitpin';
```
### Create a Client
#### Simple
```typescript
const client = new Client();
```
#### With Options
```typescript
const client = new Client({
apiKey: 'YOUR_API_KEY',
secretKey: 'YOUR_SECRET_KEY',
});
```
#### Async factory
```typescript
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](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](https://amiwrpremium.github.io/ts-bitpin/).
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see
the [tags on this repository](https://github.com/amiwrpremium/ts-bitpin/tags).
## Changelog
The changelog for this project can be found [here](CHANGELOG.md).