stonksant/polygon-api

polygon.io php client

1.0.2 2021-03-02 14:44 UTC

Requires

• amphp/websocket-client: ^0.2.4
• guzzlehttp/guzzle: ^7.0.1

Requires (Dev)

• overtrue/phplint: ^1.1
• phpunit/phpunit: ^8

MIT

• Julien Prugne

README

Installation guide

prerequisite

• composer
• php > 7.2

install

composer require polygon-io/api

Rest API

The \PolygonIO\rest\Rest class export 4 modules:

• reference
• stocks
• forex
• crypto

<?php
require __DIR__ . '/vendor/autload.php';
use PolygonIO\rest\Rest;

$rest = new Rest('your api key')

print_r($rest->forex->realtimeCurrencyConverion->get('USD', 'EUR', 10));

Websockets

The websocket clients use the Amp event loop. You can only use one websocket client by php thread since the event loop is in a blocking while loop.

<?php
require __DIR__ . '/vendor/autload.php';
use PolygonIO;

$client = new PolygonIO('your apiKey');

$client->websockets->forex(
    'C.USD',
    function($data) {
        // your handler function
    }
)

Developement

prerequisite

• composer
• php > 7.2

use the tooling

Install dependencies

composer require

Run the linter

./vendor/bin/phplint .

Run the tests

./vendor/bin/phpunit