README

CovidPHP is a PHP API wrapper for the Coronavirus tracker API.

Installation

You can install o-ba/covid-php using Composer:

composer require o-ba/covid-php

Require the composer autoloader in your script:

require 'vendor/autoload.php';

Create a instance of the API wrapper first:

$covidApi = new \Bo\CovidPHP\CovidApi();

Available methods

Methods	Parameters	Description
`getSources()`		Get all available sources.
`getLatest()`	`string $source`	Get the latest data summarized.
`getAllLocations()`	`bool $includeTimelines` (optional) `string $source` (optional)	Get all available locations.
`findByCountryCode()`	`string $countryCode` `bool $includeTimelines` (optional) `string $source` (optional)	Get country specific data based on the country code.
`findByLocation()`	`int $locationId` `bool $includeTimelines` (optional) `string $source` (optional)	Get location specific data based on the location id.

Further information

Setting $includeTimelines adds timeline data to the response
Setting $source let's you specify which source the data should be fetched from (default: jhu)

Get all available sources:

$covidApi->getSources();

Get the latest global amount of total confirmed cases, deaths and recoveries:

$covidApi->getLatest();

Get all locations:

$covidApi->getAllLocations();

Get all locations including timelines:

$covidApi->getAllLocations(true);

Get location data by country code:

$covidApi->findByCountryCode('DE');

Get location data by country code from csbs as source:

$covidApi->findByCountryCode('US', false, 'csbs');

Get location data for a specific location:

$covidApi->findByLocation(11);