API Publique

API Publique de BitBay 2.0

Nous mettrons bientôt à votre disposition la nouvelle spécification API 3.0, API 2.0 sera toujours disponible. En cas de désactivation de l’API 2.0 vous serez informé suffisamment à l’avance (environ 2 mois plus tôt).

Dépôts des appels :


https://bitbay.net/API/Public/[Devise 1][Devise 2]/[Catégorie].json
  • [Devise 1] - obligatoire, c’est le code de la cryptodevise (BTC ou LTC)
  • [Devise 2] - optionnelle, si non renseignée, par défaut c’est USD (pour les agrégats boursiers)
  • [Catégorie] - type d'appel, sont disponibles:
    • trades - les dernières transactions
    • orderbook - les offres de la bourse
    • market - les offres de la bourse et les dernières transactions
    • ticker - les statistiques de base
    • all - toutes les informations ci-dessus, réunies

Exemple :


https://bitbay.net/API/Public/BTCPLN/orderbook.json

Détails

trades - les dernières transactions

Affiche le tableau dont les éléments sont des documents JSON, classé des plus anciens jusqu’aux plus récents, au maximum il y en a 50, ce qui veut dire qu’un appel par défaut affichera les 50 premières transactions dans la devise donnée.

Exemple :


[{"date":1396340859,"price":1524.50,"amount":0.08000000,"tid":"44"},{"date":1396340875,"price":1525.00,"amount":0.13000000,"tid":"45"}]

Dans chaque document JSON vous trouverez :

  • date - la date de la transaction exprimée sous forme d’unix timestamp
  • price - le cours
  • amount - la quantité de cryptodevise dans la transaction
  • tid - l’id unique de la transaction

Il est possible de charger les transactions qui commencent par un id concret en envoyant le paramètre « since » par la méthode get où nous fournirons le tid de la transaction après laquelle nous voulons commencer, p. ex. :


https://bitbay.net/API/Public/BTCPLN/trades.json?since=43

chargera toutes les transactions à partir de la 44ème (la 43ème n’est pas concernée).

Nous pouvons ainsi charger toutes les transactions en formulant la requête plusieurs fois, en pensant à mettre dans le paramètre since le tid de la dernière transaction de la requête précédente.

En option, on peut se servir du paramètre « sort » qui accepte deux valeurs « desc » - affiche les transactions depuis la plus récente jusqu’à la plus ancienne et « ask » pour un classement inverse.

orderbook - les offres de la bourse

Affiche le document possédant 2 clés : bids et asks qui sont des tableaux, respectivement des offres d’achat et des offres de vente. Les éléments de ces tableaux sont eux-mêmes des tableaux possédant chacun 2 éléments dont le premier est le cours et le deuxième – la quantité de devise dans l’offre donnée.

Exemple :


{"bids":[[1519.00,0.07],[1513.00,0.13]],"asks":[[1529.00,0.09],[1531.00,0.12]]}

market - les offres de la bourse et les dernières transactions. La requête qui unit les deux précédentes, elle affiche le document avec des clés bids, asks et transactions. Les règles de bids et ask sont les mêmes que les transactions ci-dessus, c'est-à-dire les 50 transactions les plus récentes. Cette requête peut aussi accepter le paramètre « since » qui a une influence sur le contenu du tableau transactions, comme il est décrit au premier point.

ticker - les statistiques de base Affiche le document JSON sous la forme suivante :


{"max":4500,"min":1465,"last":1533,"bid":1513,"ask":1542,"vwap":1524.42,"average":1545.67,"volume":4.54042857}

où :

  • max est le cours de la transaction qui a eu la plus grande valeur
  • min est le cours de la transaction qui a eu la valeur la plus basse
  • bid est le cours le plus avantageux parmi les offres d’achat actuelles
  • ask est le cours le plus avantageux parmi les offres de vente actuelles
  • vwap est la moyenne pondérée des dernières 24 heures
  • average est le prix moyen calculé des 3 dernières offres de vente

all - toutes les informations ci-dessus réunies ensemble Affiche le document JSON sous la forme suivante :


{"max":4500,"min":1465,"last":1533,"bid":1513,"ask":1542,"vwap":1524.42,"average":1545.67,"volume":4.54042857, "bids" {...}, "asks": {...}, "transactions": {...}}