lox/localbtc-php

PHP client for Localbitcoins.com

Installs: 11

Dependents: 0

Stars: 7

Watchers: 6

Forks: 1

Open Issues: 2

Language: PHP

v0.1.1 2013-11-02 08:09 UTC

README

This is a (work-in-progress) client for the LocalBitcoins.com API:

https://localbitcoins.com/api-docs/

TODO

API methods:

  • Authentication
  • AccountInfo
  • Myself
  • Escrows
  • EscrowRelease
  • Ads
  • AdUpdate

Other stuff:

  • Custom errors
  • AccountInfo

Installing

Install with composer:

git clone https://github.com/lox/localbtc-php.git
composer install

Authenticating

The API uses OAuth2, so it's somewhat annoying to authenticate to for console apps. First you need to register an application and generate a client ID and client secret in the API console:

https://localbitcoins.com/accounts/api/

Then use these commands to generate a access_token:

export LOCALBITCOINS_CLIENT_ID=1234567
export LOCALBITCOINS_CLIENT_SECRET=123456

php oauth.php --authorize

Click the link generated, grant the application access in your localbitcoins.com account.

Copy the access_token from the output for the below example.

Usage

<?php

$client = \LocalBtc\Client::factory(array(
    'client_identifier' => '1234567',
    'access_token' => 'generated access token goes here',
));

// get data about yourself
$myself = $client->myself()->get('data');

// get data about someone
$someone = $client->accountInfo(array('username'=>'someone'))->get('data');

// get your escrows
$escrows = $client->escrows()->get('data');

// release an escrow
$client->releaseEscrow(array('escrow_id'=>123456));