https://github.com/tmarois/polygon-php-sdk
PHP SDK for the Polygon Market API
https://github.com/tmarois/polygon-php-sdk
marketdata polygon polygon-php-sdk polygonio quote sdk stock
Last synced: 6 months ago
JSON representation
PHP SDK for the Polygon Market API
- Host: GitHub
- URL: https://github.com/tmarois/polygon-php-sdk
- Owner: tmarois
- License: mit
- Archived: true
- Created: 2019-09-27T19:11:35.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-05-28T17:30:19.000Z (about 6 years ago)
- Last Synced: 2025-08-18T19:54:35.580Z (11 months ago)
- Topics: marketdata, polygon, polygon-php-sdk, polygonio, quote, sdk, stock
- Language: PHP
- Homepage: https://polygon.io
- Size: 14.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Polygon Market PHP SDK
This package acts as the PHP SDK for the [Polygon RESTful API](https://polygon.io/docs/#getting-started).
## Installation
Use [Composer](http://getcomposer.org/) to install package.
Run `composer require tmarois/polygon-php-sdk:^1.0`
## Getting Started
First you need to instantiate the `Polygon` object.
```php
use Polygon\Polygon;
$polygon = new Polygon("YOUR_API_KEY");
```
## Example Usage
**[Stock Snapshot](https://polygon.io/docs/#!/Stocks--Equities/get_v2_snapshot_locale_us_markets_stocks_tickers_ticker)**: Get the snapshot of a stock for the given day.
This includes the last trade, last quote, previous day and current day of data.
```php
$response = $polygon->stocks()->getSnapshot('AAPL');
```
**[Stock Details](https://polygon.io/docs/#!/Reference/get_v1_meta_symbols_symbol_company)**: Get the details of the symbol company/entity.
```php
$response = $polygon->stocks()->getDetails('AAPL');
```
**[Stock News](https://polygon.io/docs/#!/Reference/get_v1_meta_symbols_symbol_company)**: Get the details of the symbol company/entity.
```php
$response = $polygon->stocks()->getNews('AAPL', 1, 20);
```
**[Last Trade](https://polygon.io/docs/#!/Stocks--Equities/get_v1_last_stocks_symbol)**: Get the last trade for a given stock.
```php
$response = $polygon->stocks()->getLastTrade('AAPL');
```
**[Last Quote](https://polygon.io/docs/#!/Stocks--Equities/get_v1_last_quote_stocks_symbol)**: Get the last quote for a given stock.
```php
$response = $polygon->stocks()->getLastQuote('AAPL');
```
**[Trade History](https://polygon.io/docs/#!/Stocks--Equities/get_v2_ticks_stocks_trades_ticker_date)**: Get historic trades for a ticker.
```php
$response = $polygon->stocks()->getTradeHistory('AAPL','2019-09-25',$limit = 100, $timestampOffset = 0);
```
**[Quote History](https://polygon.io/docs/#!/Stocks--Equities/get_v2_ticks_stocks_nbbo_ticker_date)**: Get historic NBBO quotes for a ticker.
```php
$response = $polygon->stocks()->getQuoteHistory('AAPL','2019-09-25',$limit = 100, $timestampOffset = 0);
```
There are more in the [Polygon Documentation](https://polygon.io/docs/#getting-started) than what is presented above, if you want to extend this, please send in a pull request or request features you'd like to see added. Thanks!
## Contributions
Anyone can contribute to **polygon-php-sdk**. Please do so by posting issues when you've found something that is unexpected or sending a pull request for improvements.
## License
**polygon-php-sdk** (This Repository) is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
This SDK has no affiliation with Polygon.io, Inc and acts as an unofficial SDK designed to be a simple solution with using PHP applications. Use at your own risk. If you have any issues with the SDK please submit an issue or pull request.