Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

CryptAPI

CryptAPI's PHP Library

Official PHP library of CryptAPI

Requirements:

PHP >= 5.6
ext-curl

Install

composer require cryptapi/php-cryptapi

on GitHubon Composer

Usage

Generating a new address

<?php
require 'vendor/autoload.php'; // Where your vendor directory is

$ca = new CryptAPI\CryptAPI($coin, $my_address, $callback_url, $parameters, $cryptapi_params);
$payment_address = $ca->get_address();

Where:

$coin is the coin you wish to use, from CryptAPI's supported currencies (e.g 'btc', 'eth', 'erc20_usdt', ...)

$my_address is your own crypto address, where your funds will be sent to

$callback_url is the URL that will be called upon payment

$parameters is any parameter you wish to send to identify the payment, such as ['order_id' => 1234]

$cryptapi_params parameters that will be passed to CryptAPI (check which extra parameters are available here: https://cryptapi.io/docs/#/Bitcoin/btccreate)

$payment_address is the newly generated address, that you will show your users

Getting notified when the user pays

The URL you provided earlier will be called when a user pays, for easier processing of the request we've added the process_callback helper

<?php

require 'vendor/autoload.php'; // Where your vendor directory is

$payment_data = CryptAPI\CryptAPI::process_callback($_GET);

The $payment_data will be an array with the following keys:

address_in - the address generated by our service, where the funds were received

address_out - your address, where funds were sent

txid_in - the received TXID

txid_out - the sent TXID or null, in the case of a pending TX

confirmations - number of confirmations, or 0 in case of pending TX

value - the value that your customer paid

value_coin - the value that your customer paid, in the main coin denomination (e.g BTC)

value_forwarded - the value we forwarded to you, after our fee

value_forwarded_coin - the value we forwarded to you, after our fee, in the main coin denomination (e.g BTC)

coin - the coin the payment was made in (e.g: 'btc', 'eth', 'erc20_usdt', ...)

pending - whether the transaction is pending, if false means it's confirmed

plus, any values set on $params when requesting the address, like the order ID.

 

From here you just need to check if the value matches your order's value.

Checking the logs of a request

<?php

require 'vendor/autoload.php'; // Where your vendor directory is

$ca = new CryptAPI\CryptAPI($coin, $my_address, $callback_url, $parameters);
$data = $ca->check_logs();

Same parameters as before, the $data returned can be checked here: https://cryptapi.io/docs/#/Bitcoin/btclogs

Generating a QR code

<?php
require 'vendor/autoload.php'; // Where your vendor directory is

$ca = new CryptAPI\CryptAPI($coin, $my_address, $callback_url, $parameters, $cryptapi_params);
$payment_address = $ca->get_address();

$qrcode = $ca->get_qrcode($value, $size);

For object creation, same parameters as before. You must first call get_address as this method requires the payment address to have been created.

For QR code generation:

$value Value to request the user, in the main coin (BTC, ETH, etc). Optional, pass false to not add a value to the QR.

$size Size of the QR Code image in pixels. Optional, pass false to use the default size of 512.

Response is an object with qr_code (base64 encoded image data) and payment_uri (the value encoded in the QR), see https://cryptapi.io/docs/#operation/btcqrcode for more information.

Estimating transaction fees

<?php
require 'vendor/autoload.php'; // Where your vendor directory is

$fees = CryptAPI\CryptAPI::get_estimate($coin, $addresses, $priority);

Where:

$coin is the coin you wish to check, from CryptAPI's supported currencies (e.g 'btc', 'eth', 'erc20_usdt', ...)

$addresses The number of addresses to forward the funds to. Optional, defaults to 1.

$priority Confirmation priority, needs to be one of ['fast', 'default', 'economic']. Optional, defaults to default.

Response is an object with estimated_cost and estimated_cost_usd, see https://cryptapi.io/docs/#operation/btcestimate for more information.

Converting between coins and fiat

<?php
require 'vendor/autoload.php'; // Where your vendor directory is

$conversion = CryptAPI\CryptAPI::get_convert($coin, $value, $from);

Where:

$coin the target currency to convert to, from CryptAPI's supported currencies (e.g 'btc', 'eth', 'erc20_usdt', ...)

$value Value to convert in from.

$from Currency to convert from, FIAT or crypto.

Response is an object with value_coin and exchange_rate, see https://cryptapi.io/docs/#operation/btcconvert for more information.

Getting supported coins

<?php
require 'vendor/autoload.php'; // Where your vendor directory is

$coins = CryptAPI\CryptAPI::get_supported_coins();

Response is an array with all support coins.

Help

Need help?
Contact us @ https://cryptapi.io/contact/