https://github.com/sprak3000/animenewsnetworkdataapi
PHP client wrapper for the Anime News Network data API
https://github.com/sprak3000/animenewsnetworkdataapi
anime-news-network api-client hacktoberfest php
Last synced: about 1 year ago
JSON representation
PHP client wrapper for the Anime News Network data API
- Host: GitHub
- URL: https://github.com/sprak3000/animenewsnetworkdataapi
- Owner: sprak3000
- License: mit
- Created: 2014-10-15T14:02:27.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-07-28T01:41:35.000Z (almost 3 years ago)
- Last Synced: 2025-04-14T11:07:26.739Z (about 1 year ago)
- Topics: anime-news-network, api-client, hacktoberfest, php
- Language: PHP
- Homepage:
- Size: 161 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Anime News Network Data Client
[](https://github.com/sprak3000/AnimeNewsNetworkDataAPI/actions?query=workflow%3ATests)
[](https://codeclimate.com/github/sprak3000/AnimeNewsNetworkDataAPI/maintainability)
[](https://codeclimate.com/github/sprak3000/AnimeNewsNetworkDataAPI/test_coverage)
This is a PHP client wrapper for the [Anime News Network](http://www.animenewsnetwork.com/encyclopedia/api.php) data
API. If you are interested in contributing back to this project, feel free to read the *Contributing* documentation
below.
**NOTE:**
When using this client to retrieve data, you must still abide by the ANN API terms of service:
> When using this API to display information on a public website, you must list Anime News Network as the
source of the data and link to Anime News Network on every page that incorporates data from the API.
## Requires
* PHP ^8.0
* [Composer](https://getcomposer.org/) (to install this library)
## Usage
```php
getAnime(['anime' => '16148'])->toArray();
$manga = $client->getManga(['manga' => '4199'])->toArray();
```
### Detecting API Errors
Unfortunately, the ANN API does not return a non 200 HTTP response code for an invalid / not found ID. To check for an
error, look for a `warning` key in the result array.
### Known Limitations / Issues
None at this time.
## Installing via Composer
```
composer require sprak3000/AnimeNewsNetworkDataAPI
```
## Continuous Integration
This project uses [GitHubActions](https://github.com/sprak3000/AnimeNewsNetworkDataAPI/actions) for build and continuous integration.
## Documentation
All documentation can be found in the [doc](https://github.com/sprak3000/AnimeNewsNetworkDataAPI/blob/master/doc) folder.
## Contributing
* [Getting Started](https://github.com/sprak3000/AnimeNewsNetworkDataAPI/blob/master/doc/CONTRIBUTING.md)
* [Bug Reports](https://github.com/sprak3000/AnimeNewsNetworkDataAPI/blob/master/doc/CONTRIBUTING.md#bug-reports)
* [Feature Requests](https://github.com/sprak3000/AnimeNewsNetworkDataAPI/blob/master/doc/CONTRIBUTING.md#feature-requests)
* [Pull Requests](https://github.com/sprak3000/AnimeNewsNetworkDataAPI/blob/master/doc/CONTRIBUTING.md#pull-requests)