Giter Club home page Giter Club logo

btc-markets's Introduction

BTC Market Data

Simple PHP aggregator for cyptocurrency market data from the Australian btcmarkets.net Bitcoin exchange.

Why would I want this?

This application can be used to collect market data for trend analysis or maybe you just want an easy way to find out current price of Bitcoin and other traded currencys on BTCmarkets.net in AUD.

Application Setup:

Create a MySQL database for the application to use, and import the structure from the sql/dump.sql file.

Add the API key for your BTC Markets account and change the database parameters to match your environment in the config/config.ini

Install Composer so you can get all of the needed dependencies if you don't have it on your system already. Then run "composer install" to fetch the required dependencies

Existing Routes:

Current Price

  • /current-price/BTC - Returns the current Bitcoin ticker price.
  • /current-price/LTC - Same as the above route but for Litecoin
  • /current-price/ETH - Same as the above route but for Ether
  • /current-price/ETC - Same as above but for Ethereum Classic

Average Price

  • /average-price/BTC - Returns the average Bitcoin market price across the datapoints in the database
  • /average-price/LTC - Same as the above route but for Litecoin
  • /average-price/ETH - Same as the above route but for Ether
  • /average-price/ETC - Same as above but for Ethereum Classic

Latest Trades

  • /latest-trades - Returns information about the latest Bitcoin trades on the exchange
  • /latest-trades/LTC - Same as the above route but for Litecoin
  • /latest-trades/ETH - Same as the above route but for Ether
  • /latest-trades/ETC - Same as above but for Ethereum Classic

Order Book

  • /order-book - Get the exchange order book for Bitcoin trades
  • /order-book/BTC - Get the exchange order book for Bitcoin trades
  • /order-book/LTC - Same as the above route but for Litecoin
  • /order-book/ETH - Same as the above route but for Ether
  • /order-book/ETC - Same as above but for Ethereum Classic

Price Summary

  • /price-summary/ - Get the min, max and average BTC price over the last 24hrs
  • /price-summary/BTC - Same as above but explicitly stating you want the BTC summary
  • /price-summary/LTC - Same as above but for Litecoin
  • /price-summary/ETH - Same as above but for Ether
  • /price-summary/ETC - Same as above but for Ethereum Classic
  • /price-summary/currency/timeframe/timeseconds - Same as above for each currency but limited to a particular time frame denoted in seconds i.e /price-summary/LTC/timeframe/3600 would get a price sumary of Litecoin over the last hour.

Price Data

  • /price-data/ - Get the stored price data for BTC over the last 24hrs
  • /price-data/BTC - Same as above but explicitly stating you want the BTC summary
  • /price-data/LTC - Same as above but for Litecoin
  • /price-data/ETH - Same as above but for Ether
  • /price-data/ETC - Same as above but for Ethereum Classic
  • /price-data/currency/timeframe/timeseconds - Same as above for each currency but limited to a particular time frame denoted in seconds i.e /price-data/LTC/timeframe/3600 would get return all of the available price points in the database for Litecoin over the last hour.

Misc /update-all - Update the ticker prices for all of the active cryptocurrencies in the database /active-exchanges - Get the exchages that are currently active in the system

Required Libraries:

Dependencies are for the application are managed by Composer. The external libraries needed are as follows:

Further information can be found at the wiki for the BTC markets API on github:

Roadmap

  • Add new Bitcoin exchanges other than BTC Markets
  • Add support for other currencies other than AUD
  • Cleanup the routing

Licence

Copyright (C) 2016 Anthony Mills

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

btc-markets's People

Contributors

anthony-mills avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.