Azgrom / Cryptowatch.API

API for cryptowat.ch

CryptoWatch REST API Client Library

This library provides a client to interact with the CryptoWatch REST API. You can access various information related to cryptocurrency markets including assets, exchanges, market data, and trading pairs.

Table of Content

• How it Works
• Requirements
  • Inputs
  • Outputs
• Example Usage
• Step-by-step Guide
• Contributing
  • Bugs and Features
  • Update the Source Code
  • Versioning and Releases
• Notes

How it Works

The library sends HTTP requests to the CryptoWatch REST API and returns parsed responses. It abstracts the details of HTTP and API specifics, providing a clean and easy-to-use interface.

Requirements

Inputs

• API credentials (optional)
• HttpClient instance

Outputs

• Parsed API responses, such as lists of assets, exchanges, markets, etc.

Example Usage

var api = new CryptoWatchRestApi(httpClientFactory);
var assets = await api.Assets.ListAsync();

Step-by-step Guide

1. Install the CryptoWatch REST API Client Library package to your project. It is available at nuget;
2. Create an instance of the CryptoWatchRestApi class;
3. Use various methods like ListAsync() to interact with different parts of the CryptoWatch API;

Contributing

Bugs and Features

• Please open an issue to report a bug or request a feature.

Update the Source Code

• Clone the repository.
• Create a new branch for your feature or bugfix.
• Commit your changes and open a Pull Request.

Versioning and Releases

• We use Semantic Versioning.
• For the versions available, see the tags on this repository.

Notes

• Ensure you have the necessary API credentials if your usage exceeds the public limits.
• The library is designed to be used with a properly configured HTTP client.

License

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