Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /var/www/html/123vid/vendor/nicklaw5/twitch-api-php/ |
# twitch-api-php
A Twitch API client for PHP.
[](https://travis-ci.org/nicklaw5/twitch-api-php)
## Supported APIs
This library aims to support `v3`, `v4` and `v5` of the Twitch API until each one becomes [deprecated](https://dev.twitch.tv/docs#which-api-version-can-you-use). If an API version is not specified, `v5` will be used as the default.
## Features Completed
**Main API Endpoints:**
- [x] Authentication
- [x] Bits
- [x] Channel Feed
- [x] Channels
- [x] Chat
- [x] Clips
- [x] Collections
- [x] Communities
- [x] Games
- [x] Ingests
- [x] Search
- [x] Streams
- [x] Teams
- [x] Users
- [x] Videos
Any endpoints missing? Open an [issue here](https://github.com/nicklaw5/twitch-api-php/issues).
**Other Features:**
- [ ] IRC Client
- [ ] Pub/Sub (ie. Bits & Whispers)
- [ ] Video Upload
**Additional Integrations:**
- [ ] [StreamsLabs:](https://twitchalerts.readme.io/docs/getting-started)
- [ ] Alerts
- [ ] Authentication
- [ ] Donations
- [ ] Users
## Basic Example
```php
$options = [
'client_id' => 'YOUR-CLIENT-ID',
];
$twitchApi = new \TwitchApi\TwitchApi($options);
$user = $twitchApi->getUser(26490481);
// By default API responses are returned as an array, but if you want the raw JSON instead:
$twitchApi->setReturnJson(true);
$user = $twitchApi->getUser(26490481);
// If you want to switch between API versions on the fly:
$twitchApi->setApiVersion(3);
$user = $twitchApi->getUser('summit1g');
```
See the [examples](examples) directory for more common use cases.
## Requirements
PHP 5.6 or higher is required.
## Installation
Either pull in the library via composer:
```bash
$ composer require nicklaw5/twitch-api-php
```
or add the following dependency to your `composer.json` file and run `composer install`:
```json
"nicklaw5/twitch-api-php": "0.1.*"
```
## Tests
All unit tests can be run with the following command:
```bash
$ vendor/bin/phpunit # or simply "phpunit" if you have it installed globally
```
## Documentation
The Twitch API docs can be found [here](https://dev.twitch.tv/docs).
As for the documentation of this library, that is still on the to-do list. In the meantime, most modern IDEs by default, or through the use of plugins, will provide class property and method auto-completion. Or you can simple look through the [source](src) code.
## License
Distributed under the [MIT](LICENSE) license.