Skip to content

DEPRECATED - A single class PHP client made for communicating with the Coinbase Pro API.

License

Notifications You must be signed in to change notification settings

KonstaHallinen/coinbase-pro-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 

Repository files navigation

DEPRECATED

Coinbase has announced that they will close the Coinbase Pro and the Exchange REST API. You should migrate to Advanced Trade API instead.

Coinbase Pro API PHP client

A single class PHP client made for communicating with the Coinbase Pro API.

Disclaimer

This is an unofficial project and made without any cooperation with the Coinbase staff.

Usage

Refer to the official API documentation for more detailed information about the possible query parameters and returned values. Almost every* function is named after the documentation URL, so for example Get product trades (getproducttrades) would use a function called get_product_trades and so on.

Here is a basic code example:

// Include the file
require_once('class-coinbase.php');

// Initialise the class. You can leave the variables empty if you only need to use public methods.
$coinbase = new CoinbaseExchange('Your API key', 'Your API secret', 'Your API passphrase');

// Call a function. GET parameters can be added to the API call by using an array.
$trades = $coinbase->get_product_trades('USDC-EUR', array('limit' => '2'));

/* Returned JSON is automatically converted in to an array so var_dump($trades); would print something like this:
array(2) {
  [0]=>
  array(5) {
    ["time"]=>
    string(27) "2021-09-27T17:58:59.424327Z"
    ["trade_id"]=>
    int(3852088)
    ["price"]=>
    string(10) "0.85500000"
    ["size"]=>
    string(11) "56.27000000"
    ["side"]=>
    string(4) "sell"
  }
  [1]=>
  array(5) {
    ["time"]=>
    string(27) "2021-09-27T17:58:54.818301Z"
    ["trade_id"]=>
    int(3852087)
    ["price"]=>
    string(10) "0.85500000"
    ["size"]=>
    string(13) "1498.71000000"
    ["side"]=>
    string(4) "sell"
  }
} */

Errors will also be returned as arrays. There are basically two types of errors that could occur:

// API error. Caused most likely by wrong credentials or missing a required parameter. Example:
array(1) {
  ["error"]=>
  string(24) "API error: Unauthorized."
}

// cURL error. Caused most likely by connection issues. Example:
array(1) {
  ["error"]=>
  string(61) "cURL error: Could not resolve host: api.exchange.coinbase.com"
}

About

DEPRECATED - A single class PHP client made for communicating with the Coinbase Pro API.

Topics

Resources

License

Stars

Watchers

Forks

Languages