Glossary

Account: a personal account or an organization, addressed by a handle. Owns API keys.

API key: a secret beginning aggre_sk_ that authenticates data API calls. Shown once.

As of (as_of): a query that returns each period as Aggre knew it at a given instant, ignoring later revisions.

Attribution / credit: text a publisher's terms ask to be shown with its data. Returned with the rows; display it as returned.

Cursor: an opaque string (next_cursor) you pass back as cursor to get the next page.

Dataset: one kind of row with one schema and one route, identified as {domain}.{category}.{name}.

Envelope: the { "data", "meta", "next_cursor" } shape of a data answer.

Handle: the lowercase name of an account or organization, shared namespace.

Instrument: a market product identified as {VENUE}:{PRODUCT}:{native}.

Meta (meta): the object that says where data came from and how fresh it is (source, status, fetchedAt, dataDate, message).

Restricted: a statute flag meaning the text carries use restrictions; attribution must be shown.

Stale: meta.status when Aggre's last successful read is older than the dataset's freshness window.

Terms gate: the rule that a source is read and served only after a person has read the publisher's terms. Until then routes answer 503 terms_unread or carry no licence.

Version: a revision of one observation or record. A changed value is stored as the next version; earlier ones are kept.

Whoami: GET /v1/whoami, which describes the calling key and its usage.