navigation bar
url structure
api documentation sidebar

URL structure

Queries are performed using a uniform resource locator (URL) that contains the following ingredients:

url = base_url/endpoint?query_string

  1. base_url = The base webpage containing the API

    https://www.gmdatabase.org

    Note that entering the base url into your web browser without also specifying an endpoint and query string will take you to the homepage. The endpoint is necessary to retrieve data from the database. The query string is optional, and can be used to customize your queries.
  2. endpoint = An endpoint is a location where an API receives requests about a resource. Supported endpoings include "schema" and "flatfile" as described in more detail through links in the navigation tree. An endpoint to return timeseries data is currently under development.
  3. query_string = A list of parameters used to request specific data from the server. If a query string is not specified, a default dataset will be returned.