LiveStories IQ developers
Documentation

LiveStories Public API

The LiveStories public API lets you download public datasets published on LiveStories.

No authentication is required to do so. However you need to identify the organization in LiveStories from which you want to download datasets. For each organization (or team) in LiveStories there is a specific endpoint that presents a list of all their public datasets. The URL follows this convention:

https://api.livestories.com/dataset/?team=<:team_id>

This URL is available in LiveStories on the Team Page. Organizations that make datasets available for download are encouraged to share this public URL.

Conventions

Endpoints adhere to the following conventions/principles.

JSON

Outputs are JSON-encoded.

Stateless

All endpoints are stateless, operating purely upon RESTful semantics.

Versioned

All endpoints are prefixed with the version they're applicable to.

Encryption

All endpoints are available through https only, ensuring encryption during all exchanges.

Entities

All endpoints effectively perform operations on Datasets in your account on your behalf. Your identity is established through your API key.

All datasets expose the following properties:

{ "id": "<Dataset UUID Identifier>", "version": "<Dataset UUID Version>", "name": "<Dataset Friendly Name>", "visibility": "<public|private>", "deleted": "<Deleted Date>", "created": "<Created Date>", "properties": { "description": "...", "key_words": [...], "contact_name": "...", "contact_email": [...], "publisher": "...", "source_url": "..."} }
id

Entity reference/identifier. Precise format of this field varies by entity type.

Example Valuexxxxxxxx

name

Entity description suitable for display as a formal name (e.g. "Calvert County, MD").

Example ValueCalvert County, MD

description

Verbose entity description.

Example Valuexxxxxxxxx

visibility

Whether a dataset is public or private.

Example Valuepublic

properties

Additional properties about a dataset. These include: publisher, description, key_words, contact_name, contact_email, source_url.

Example Value{"description": "Obesity rate by city", "key_words": ["health"]}