Grandad, is that you?

Your browser is out of date and doesn't support all of the cool stuff we do on our website.

We like Google Chrome, but any modern browser will do.Update my browser now

×

API documentation

Location

Defines the geographical location of a project. Posted projects one need only specify the address field as we will use geocoding to determine the remaining fields, although we will use the supplied detailed fields in preference.

Note that while we allow latitude / longitude to be set it isn't required, as we can usually geolocate based on the textual address.

This data structure is used in for several fields in the project definition.

Fields

Field Type Description Required (POST)? Example
address string The full location string. This is actually the only field we really require, as we'll use geolocation services to fill in the remaining fields. However if you already have the more detailed fields then we will use them in preference to geolocation. Yes e.g "Salisbury House, Cambridge, UK"
country_code string Country code. We use the ISO 3166-1 alpha-2 country codes. If not specified we will attempt to determine this from the full location string. No e.g "UK"
city string City. We will attempt to determine this from the full location string if not specified. No e.g "Cambridge"
state string State or county. We will attempt to determine this from the full location string if not specified. No e.g "New York"
region string Geographics region. This is not a writable field. No e.g "Europe"
latitude float Latitude No e.g "-45.24343"
longitude float Longitude No e.g "15.36234"

Example

{ "address": "Charleston, South Carolina, United States" }