xbugszone/cryptotools

Framework with tools to trade cryptocurrency

Maintainers

Details

github.com/xbugszone/cryptotools

Source

Issues

Installs: 8

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 1

Forks: 0

Open Issues: 0

Type:package

dev-main 2021-11-27 12:54 UTC

Requires

MIT 9dc458a52e780f2a12d95fdf8f5dd363007dfe7b

  • tiago <xbugszone.woop@gmail.com>

frameworkapilibrarytoolkitordermerchandisecurrencypricenovacryptobote-commerceprivatemerchantpublicbitcoinstrategycurrencieslitecoinlightmarketexchangebtccryptocurrencytradingminimaldashdogecoinaltcoinkrakenrippleDOGEinvestorindependent reservexbtvolumetradePoloniexetherethereumEURUSDCNYWexcoinmercadobitcoinaltcoinsyunbicoinmarketcapbtc-ebittrexbitsobtcebitflyerbitfinexbitstampdsxtradergdaxbinancehitbtcalgorithmicalgotradingarbitragebacktestbacktestingcoinscrypto currencycrypto marketdarkcoindigital currencyetcethexchangesinvestinvestingltcmarket datamarketsorderbookorder bookprice datapricefeedxrpzeczerocoin1Broker1BTCXEACXacx.ioANXANXProbinance.combit2c.co.ilBit2CBitBayBitBaysbitcoincoidBitcoin.co.idbitflyer.jpbithumbbithumb.combitlishBitMarketBitMEXBL3PBleutradebleutrade.comBlinkTradeBtcBoxbtcbox.co.jpBTCCBTCChinaBTCExchangebtcexchange.phBTC Marketsbtcmarketsbtcmarkets.netBTCTraderbtctrader.combtc-trade.com.uaBTC Trade UABTCTurkbtcturk.comBTCXbtc-xbterBter.comBX.in.thccexC-CEXcexCEX.IOCHBTCChileBitchilebit.netcoincheckcoingicoingi.comCoinMateCoinsecureCoinSpotcoinspot.com.auCrypto Capitalcryptocapital.codsx.ukEXMOflowBTCflowbtc.comFoxBitfoxbit.exchangeFYB-SEFYB-SGGatecoinGeminiHuobiHuobiPROhuobi.proindependentreserve.comitBitjubi.comLakeBTClakebtc.comLiveCoinLiquiliqui.iolunomercadomercadobitcoin.brmixcoinsmixcoins.comnovaexchangenovaexchange.comOKCoinOKCoin.comOKCoin.cnOKEXokex.comPaymiumQuadrigaCXQryptosQUOINESouthxchangeSurBitcoinsurbitcoin.comTidextidex.comTheRockTradingUrduBiturdubit.comVaultoroVBTCvbtc.exchangevbtc.vnVirWoXwex.nzxBTCexbtce.comYoBityobit.netZaif

This package is auto-updated.

Last update: 2024-04-27 19:00:07 UTC

README

cryptocoins.png?raw=true

Contributors Forks Stargazers Issues MIT License


CryptoTools Framework

CryptoFramework is a framework intended to easily create bots to manage cryptocurrencies.

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

CryptoFramework is a framework intended to easily create bots to manage cryptocurrencies.

(back to top)

Built With

(back to top)

Getting Started

To get started you can use as base a framework like laravel or symfony but for this example I will use it in a blank project

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • composer blank project 
    composer init

Installation

  1. install package in the blank project folder
composer require xbugszone/cryptotools

(back to top)

Usage

  1. Create a folder called Brokers in your project and with a file inside, for this example we will use the Bitstamp exchange so lets call this file MyBitstamp.php In this file should be this code
namespace App\Brokers;

use ccxt\bitstamp;
use Xbugszone\Cryptotools\Brokers\CCTXBroker;

class MyBitstamp extends CCTXBroker
{
protected string $exchange = bitstamp::class;
protected string $apiKey = "your api key";
protected string $apiSecret = "your api secret";
}

  1. Get the API Key from the selected exchange and update on the file

  2. Now to run this app we create a file inside our project but outside of the Brokers folder and we can call it run.php with the following code:

<?php

namespace App\Console\Commands;

use App\Brokers\MyBitstamp;
$broker = new MyBitstamp();
print_r($broker->getBalance());

(back to top)

Roadmap

  • [] Brokers automatic stubs
  • [] Signals
  • [] Strategies
    • [] Bot squeleton stubs

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Tiago Andre xbugszone@gmail.com

https://github.com/xbugszone/cryototools

(back to top)

Acknowledgments

(back to top)