Skip to content

Add relevant API endpoints to new release

Here's a list of endpoints I could find in the schema and my opinions on each:

  • /rankings - ❓ A set of dimensions is POSTed, but I don't really understand this one
  • /report/headers - ❓ Similar to rankings
  • /report/data - ❓ Same as above
  • /datasize - ✔ This one gives you the size of the data you're about to download, I think we should expose it in case a user needs an estimate of size
  • /groupsanddomains - ✔ List of all domains and groups
  • /dimensions/{domain_code} - ✔ Gives a description of all columns in a dataset
  • /codes/{id}/{domain_code} - ✔ Code lists for dimensions. Only seems to give FAO codes, I can't persuade it to give M49.
  • /groups - ✔ List of groups
  • /domains/{group_code} - ✔ List of domains in a group
  • bulkdownloads/{domain_code} - ✔ We'll keep this functionality
  • /documents/{domain_code}/ - ✔ List of files attached to the domain. Not really sure how to retrieve them yet, but this seems like useful metadata someone would want
  • /suggestions - ✔ A general search of everything for a keyword. I think this is really neat.
  • /search - ✔ Like suggestions but seems to only return indicators and elements
  • /metadata/{domain_code} - ✔ Gives a lot of metadata including notes
  • /metadata_print/{domain_code} - ❓ Couldn't get this to work
  • /definitions/types - ✔ Seems to be a definition of all possible dimensions
  • /definitions/types/{type} - ✔ Definite keep - It contains all codes and their conversions for all dimensions
  • /definitions/domain/{domain_code} - ❓ I couldn't figure this one out
  • /definitions/domain/{domain_code}/{type} - ❓ This seems to give something similar to definitions/types/{type} but for area it includes start year and end year as opposed to just conversions.
  • /data/{domain_code} - ✔ This is what read_fao already uses
  • /ping - ❌ I don't think we need this. I might implement it if I'm bored
Edited by Sebastian