An open API service indexing awesome lists of open source software.

https://github.com/shahradelahi/coinex

[WIP] ✨ Type-safe HTTP and WebSocket clients for CoinEx API
https://github.com/shahradelahi/coinex

api coinex cryptocurrency exchange http websocket

Last synced: 9 months ago
JSON representation

[WIP] ✨ Type-safe HTTP and WebSocket clients for CoinEx API

Awesome Lists containing this project

README

          

# CoinEx API Clients for Javascript/Typescript

This repository contains HTTP and WebSocket clients for interacting with the CoinEx API v2.

## Packages

This repository includes the following packages:

- [`@coinex-org/coinex`](./packages/coinex): The HTTP client for CoinEx API v2.
- [`@coinex-org/websocket`](./packages/websocket): The WebSocket client for CoinEx API v2.

## Official Documentation

For detailed information on the CoinEx API v2, please refer to the [official documentation](https://docs.coinex.com/api/v2/).

## Obtaining API Keys

To use these clients, you will need an API Key (`access_id`) and Secret Key from CoinEx. Follow these steps to obtain them:

1. Log in to your CoinEx account.
2. Navigate to the API management page.
3. Create a new API key or use an existing one.
4. Obtain your `access_id` and `secret_key` from the created API record.

## License

[MIT](/LICENSE) © [Shahrad Elahi](https://github.com/shahradelahi) and [contributors](https://github.com/shahradelahi/coinex/graphs/contributors).

## Notice of Non-Affiliation and Disclaimer

We are not affiliated, associated, authorized, endorsed by, or in any way officially connected with CoinEx, or any of its subsidiaries or its affiliates. The official CoinEx website can be found at https://coinex.com/.

The name CoinEx as well as related names, marks, emblems and images are registered trademarks of their respective owners.