kedro.extras.datasets.api.APIDataSet

class kedro.extras.datasets.api.APIDataSet(url, method='GET', data=None, params=None, headers=None, auth=None, json=None, timeout=60, credentials=None)

APIDataSet loads the data from HTTP(S) APIs. It uses the python requests library: https://requests.readthedocs.io/en/latest/

Example usage for the YAML API:

usda:
  type: api.APIDataSet
  url: https://quickstats.nass.usda.gov
  params:
    key: SOME_TOKEN,
    format: JSON,
    commodity_desc: CORN,
    statisticcat_des: YIELD,
    agg_level_desc: STATE,
    year: 2000

Example usage for the Python API:

from kedro.extras.datasets.api import APIDataSet


data_set = APIDataSet(
    url="https://quickstats.nass.usda.gov",
    params={
        "key": "SOME_TOKEN",
        "format": "JSON",
        "commodity_desc": "CORN",
        "statisticcat_des": "YIELD",
        "agg_level_desc": "STATE",
        "year": 2000
    }
)
data = data_set.load()

Methods

exists()	Checks whether a data set's output already exists by calling the provided _exists() method.
from_config(name, config[, load_version, ...])	Create a data set instance using the configuration provided.
load()	Loads data by delegation to the provided load method.
release()	Release any cached data.
save(data)	Saves data by delegation to the provided save method.

__init__(url, method='GET', data=None, params=None, headers=None, auth=None, json=None, timeout=60, credentials=None)

Creates a new instance of APIDataSet to fetch data from an API endpoint.

Parameters:

• url (str) – The API URL endpoint.

• method (str) – The Method of the request, GET, POST, PUT, DELETE, HEAD, etc…

• data (Optional[Any]) – The request payload, used for POST, PUT, etc requests https://requests.readthedocs.io/en/latest/user/quickstart/#more-complicated-post-requests

• params (Optional[Dict[str, Any]]) – The url parameters of the API. https://requests.readthedocs.io/en/latest/user/quickstart/#passing-parameters-in-urls

• headers (Optional[Dict[str, Any]]) – The HTTP headers. https://requests.readthedocs.io/en/latest/user/quickstart/#custom-headers

• auth (Union[Iterable[str], AuthBase, None]) – Anything requests accepts. Normally it’s either ('login', 'password'), or AuthBase, HTTPBasicAuth instance for more complex cases. Any iterable will be cast to a tuple.

• json (Union[List, Dict[str, Any], None]) – The request payload, used for POST, PUT, etc requests, passed in to the json kwarg in the requests object. https://requests.readthedocs.io/en/latest/user/quickstart/#more-complicated-post-requests

• timeout (int) – The wait time in seconds for a response, defaults to 1 minute. https://requests.readthedocs.io/en/latest/user/quickstart/#timeouts

• credentials (Union[Iterable[str], AuthBase, None]) – same as auth. Allows specifying auth secrets in credentials.yml.

Raises:

ValueError – if both credentials and auth are specified.

exists()

Checks whether a data set’s output already exists by calling the provided _exists() method.

Return type:

bool

Returns:

Flag indicating whether the output already exists.

Raises:

DatasetError – when underlying exists method raises error.

classmethod from_config(name, config, load_version=None, save_version=None)

Create a data set instance using the configuration provided.

Parameters:

• name – Data set name.

• config – Data set config dictionary.

• load_version – Version string to be used for load operation if the data set is versioned. Has no effect on the data set if versioning was not enabled.

• save_version – Version string to be used for save operation if the data set is versioned. Has no effect on the data set if versioning was not enabled.

Returns:

An instance of an AbstractDataset subclass.

Raises:

DatasetError – When the function fails to create the data set from its config.

load()

Loads data by delegation to the provided load method.

Return type:

TypeVar(_DO)

Returns:

Data returned by the provided load method.

Raises:

DatasetError – When underlying load method raises error.

release()

Release any cached data.

Raises:

DatasetError – when underlying release method raises error.

Return type:

None

save(data)

Saves data by delegation to the provided save method.

Parameters:

data (TypeVar(_DI)) – the value to be saved by provided save method.

Raises:

• DatasetError – when underlying save method raises error.

• FileNotFoundError – when save method got file instead of dir, on Windows.

• NotADirectoryError – when save method got file instead of dir, on Unix.

Return type:

None