Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/techtailor/laravel-coindcx-api
A Laravel Wrapper for the CoinDCX API. Now easily connect and consume the CoinDCX Public API in your Laravel apps without any hassle.
https://github.com/techtailor/laravel-coindcx-api
coindcx coindcx-api coindcx-api-laravel coindcxapi laravel-coindcx
Last synced: 2 days ago
JSON representation
A Laravel Wrapper for the CoinDCX API. Now easily connect and consume the CoinDCX Public API in your Laravel apps without any hassle.
- Host: GitHub
- URL: https://github.com/techtailor/laravel-coindcx-api
- Owner: TechTailor
- License: mit
- Created: 2021-11-27T12:42:58.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-24T18:23:23.000Z (about 2 years ago)
- Last Synced: 2024-10-12T11:06:41.632Z (about 1 month ago)
- Topics: coindcx, coindcx-api, coindcx-api-laravel, coindcxapi, laravel-coindcx
- Language: PHP
- Homepage:
- Size: 15.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
[](https://packagist.org/packages/techtailor/laravel-coindcx-api)
[](https://github.com/TechTailor/Laravel-CoinDCX-Api/issues)
[](license.md)
[](https://packagist.org/packages/techtailor/laravel-coindcx-api)
This package provides a Laravel Wrapper for the [CoinDCX API](https://docs.coindcx.com/) and allows you to easily communicate with it.
---
#### Important Note
This package is in early development stage. It is not advisable to use it in a production app until **`v1.0`** is released. Feel free to open a PR to contribute to this project and help me reach a production ready build.
---
### Installation
You can install the package via composer:
```bash
composer require techtailor/laravel-coindcx-api
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="coindcx-api-config"
```
Open your `.env` file and add the following (replace ``YOUR_API_KEY`` and ``YOUR_SECRET`` with the API Key & Secret you received from [CoinDCX](https://coindcx.com/api-dashboard)) -
```php
COINDCX_KEY=YOUR_API_KEY
COINDCX_SECRET=YOUR_SECRET
```
Or
Open the published config file available at `config/coindcx-api.php` and add your API and Secret Keys:
```php
return [
'auth' => [
'key' => env('COINDCX_KEY', 'YOUR_API_KEY'),
'secret' => env('COINDCX_SECRET', 'YOUR_SECRET')
],
];
```
### Usage
Using this package is very simple. Just initialize the Api and call one of the available methods:
```php
use TechTailor\CoinDCXApi\CoinDCXApi;
$cdx = new CoinDCXApi();
$ticker = $cdx->getTicker();
```
You can also set an API & Secret for a user by passing it after initalization (useful when you need to isolate api keys for individual users):
```php
$cdx = new CoinDCXApi();
$cdx->setApi($apiKey, $secretKey);
$accountInfo = $cdx->getAccountInfo();
```
### Available Methods
Available Public Methods (Security Type : `NONE`) **[API Keys Not Required]**
```
- getTicker() // returns the exchange ticker
- getMarkets() // returns the exchange markets list
- getMarketsDetails() // returns the exchange markets details
- getMarketTrades() // returns the exchange markets trade history
```
Available Private Methods (Security Type : `AUTHENTICATED`) **[API Keys Required]**
```
- getAccountInfo() // returns user account info (coindcx_id, email, etc)
- getBalances() // returns user account balances
- getTradeHistory() // returns user's complete spot trade history
- getActiveOrders() // returns user's active orders list
```
### TODO
List of features or additional functionality we are working on (in no particular order) -
```bash
- Improve exception handling.
- Add rate limiting to API Calls.
- Add response for API ban/blacklisting response.
- Improve ReadMe.
```
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
### Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
### Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
### Credits
- [Moinuddin S. Khaja](https://github.com/TechTailor)
- [All Contributors](../../contributors)
### License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.