Difference between revisions of "Do you have an API?"

From Bittylicious
Jump to navigation Jump to search
Line 5: Line 5:
==Quote (number of coins)==
==Quote (number of coins)==


''https://bittylicious.com/api/v1/quote/COIN/COUNTRY/CURRENCY/PAYMETHOD/AMOUNT''
''https://bittylicious.com/api/v1/quote/COIN/COUNTRY/CURRENCY/PAYMETHOD/AMOUNT/DIRECTION''


* '''COIN''': The virtual currency, e.g. BTC
* '''COIN''': The virtual currency, e.g. BTC
Line 12: Line 12:
* '''PAYMETHOD''': The payment method, e.g. BANK, PINGIT or CASH
* '''PAYMETHOD''': The payment method, e.g. BANK, PINGIT or CASH
* '''AMOUNT''': The amount of virtual currency, e.g. 1
* '''AMOUNT''': The amount of virtual currency, e.g. 1
* '''DIRECTION''': The direction of the purchase, either BUY or SELL


For example, to return the current price of 1 BTC in the UK using GBP via bank transfer, call https://bittylicious.com/api/v1/quote/BTC/GB/GBP/BANK/1
For example, to return the current price of 1 BTC in the UK using GBP via bank transfer, call https://bittylicious.com/api/v1/quote/BTC/GB/GBP/BANK/1
Line 17: Line 18:
==Quote (amount of fiat)==
==Quote (amount of fiat)==


''https://bittylicious.com/api/v1/quoteFiat/COIN/COUNTRY/CURRENCY/PAYMETHOD/AMOUNT''
''https://bittylicious.com/api/v1/quoteFiat/COIN/COUNTRY/CURRENCY/PAYMETHOD/AMOUNT/DIRECTION''


* '''COIN''': The virtual currency, e.g. BTC
* '''COIN''': The virtual currency, e.g. BTC
Line 24: Line 25:
* '''PAYMETHOD''': The payment method, e.g. BANK, PINGIT or CASH
* '''PAYMETHOD''': The payment method, e.g. BANK, PINGIT or CASH
* '''AMOUNT''': The amount of fiat, e.g. 100
* '''AMOUNT''': The amount of fiat, e.g. 100
* '''DIRECTION''': The direction of the purchase, either BUY or SELL


For example, to return the number of BTC that 100 GBP can buy in the UK via bank transfer, call https://bittylicious.com/api/v1/quoteFiat/BTC/GB/GBP/BANK/100
For example, to return the number of BTC that 100 GBP can buy in the UK via bank transfer, call https://bittylicious.com/api/v1/quoteFiat/BTC/GB/GBP/BANK/100

Revision as of 10:16, 25 April 2014

We have a simple API where you can get the current price offered by Bittylicious.

Prices

Quote (number of coins)

https://bittylicious.com/api/v1/quote/COIN/COUNTRY/CURRENCY/PAYMETHOD/AMOUNT/DIRECTION

  • COIN: The virtual currency, e.g. BTC
  • COUNTRY: The ISO country code, e.g. GB
  • CURRENCY: The currency, e.g. GBP
  • PAYMETHOD: The payment method, e.g. BANK, PINGIT or CASH
  • AMOUNT: The amount of virtual currency, e.g. 1
  • DIRECTION: The direction of the purchase, either BUY or SELL

For example, to return the current price of 1 BTC in the UK using GBP via bank transfer, call https://bittylicious.com/api/v1/quote/BTC/GB/GBP/BANK/1

Quote (amount of fiat)

https://bittylicious.com/api/v1/quoteFiat/COIN/COUNTRY/CURRENCY/PAYMETHOD/AMOUNT/DIRECTION

  • COIN: The virtual currency, e.g. BTC
  • COUNTRY: The ISO country code, e.g. GB
  • CURRENCY: The currency, e.g. GBP
  • PAYMETHOD: The payment method, e.g. BANK, PINGIT or CASH
  • AMOUNT: The amount of fiat, e.g. 100
  • DIRECTION: The direction of the purchase, either BUY or SELL

For example, to return the number of BTC that 100 GBP can buy in the UK via bank transfer, call https://bittylicious.com/api/v1/quoteFiat/BTC/GB/GBP/BANK/100

Ticker for all currency pairs

https://bittylicious.com/api/v1/ticker

This returns an array of currency pairs, e.g. GBPBTC, which in turn provides an array of pricing information. The structure is:

  • CurrencyPair, e.g. GBPBTC
    • avg_1h: Average price over the last hour
    • avg_3h: Average price over the three hours
    • avg_6h: Average price over the six hours
    • avg_12h: Average price over the twelve hours
    • avg_24h: Average price over the twenty four hours
    • volume_24h: Volume over the last twenty four hours
    • rates:
      • last: Last price a sale was made at

Example:

{"GBPBTC":{"avg_1h":"396.999997","avg_3h":"397.001120","avg_6h":"397.003127",
  "avg_12h":"397.036739","avg_24h":"397.535174","volume_24h":"40.19171396",
  "rates":{"last":"397.000000"}},
 "ZARBTC":"avg_1h":null,"avg_3h":null,"avg_6h":null,"avg_12h":null,
  "avg_24h":null,"volume_24h":"0.00000000","rates":{"last":null}}}

Trade list for the last day

https://bittylicious.com/api/v1/trades/COIN/CURRENCY

  • COIN: The virtual currency, e.g. BTC
  • CURRENCY: The currency, e.g. GBP

The returned list is an array with each entry containing the following values:

  • timestamp: Unix timestamp corresponding to the time the trade ended
  • tid: The unique trade identifier
  • fiat: The amount of fiat that was exchanged
  • amount: The amount of virtual currency that was exchanged

User Interface

https://bittylicious.com/coin/COIN

https://bittylicious.com/coin/COIN/PAYMETHOD

  • COIN: Default to use this virtual currency, e.g. BTC
  • PAYMETHOD: Default to use this payment method, e.g. BANK, CASH, PINGIT