Skip to content

Instantly share code, notes, and snippets.

@natdudley
natdudley / api.md
Last active August 16, 2016 21:22
Figure.NZ API

We're in the process of rebuilding our Figure.NZ API after building a new database structure earlier this year, and we want to get your input.

We hold a bunch of different types of objects:

  • Tables, which have been extracted and standardized into machine-readable formats. Most of these are sourced from various open government data sets.
  • Charts, created from our datasets to meet our charting standards, available in a variety of formats.
  • Enumerations, relations, and synonyms. These are concepts we've built up to describe links between data.
    • Enumerations: Lists used to standardize items, enabling us to define things in a consistent way. For example, a list of fields of study might have a standardized format for Computer Science. Enumerations are used to build relations.
    • Administrative relations: Te Aro has a relationship to Wellington City which has a relationship to Wellington Region, which has a relationship to New Zealand.
  • Conceptual relations: An aircraft pilot is related to the airp