Getting Started

Authentication

Currently the Cal-Adapt API does not require authentication. You do not need to sign up for a key to start working with the API. We plan to maintain the current level of open access to support a wide range of users. However, authentication may be implemented in the future to support throttled access for selected applications.

Entry Point

The entry point or API root is a starting point that provides an overview of all available data in the API. The entry point for the Cal-Adapt API is:

http://api.cal-adapt.org/api/

Browsable API View

When you open the above entry point in a browser, you will see an easy to read, browsable view of the Cal-Adapt API. The browsable API view provides a quick overview of available data resources in the API and the URLs to access these data resources. This makes it easier and convenient to test requests and their returns in a web browser.

Data Formats

In a web browser by default, the API will return data as HTML. One way to request data in a different format is by adding the format query parameter to the URL.

http://api.cal-adapt.org/api/?format=json

The Cal-Adapt API supports the following data formats:

  • Raster and vector data
    • Browsable API view (api)
    • JavaScript Object Notation (json)
  • Raster data only
    • Comma Separated Values (csv)
    • GeoTIFF (tif.zip)
    • ERDAS Imagine (img.zip)
  • Vector data only
    • GeoJSON (geojson)
    • Keyhole Markup Language (kml)
    • Zipped KML files (kmz)

However, our preferred way to indicate data format (instead of adding format=json in the URL) is to use the appropriate HTTP Accept header in your requests, e.g.:

Accept: application/json