Location API

This is a location API, providing many of the common building blocks of location. Providing the essential location ingredients needed through a varietiy of applications, without having to reivent the wheel each times it is needed. This API is still being working on, and not quite ready for prime time, but if you have any questions, visit the road map and support sections below the documentation.



This Site Is Currently Under Development



API Evangelist Partners

These are my partners who invest in API Evangelist each month, helping underwrite my research, and making sure I'm able to keep monitoring the API space as I do.

Streamdata.io

Streamdata is a software vendor making real-time data accessible to all by operating a proxy turning request / response APIs into feeds of real-time events.

Uptrends

Uptrends is the ultimate monitoring tool to stay in control of the uptime, performance, and functionality of your websites, APIs, and servers.

3Scale

3scale makes it easy to open, secure, distribute, control and monetize APIs, that is built with performance, customer control and excellent time-to-value in mind.

Sign Up / Login

We do not require you to signup for yet another account, rather just let you create your account and login using one of your existing social media accounts.

Github

Twitter

Google

LinkedIn

Login is not currently turned on for this API, please submit a support request to get access currently, and inquire as to the status of this API.



Authentication

This API uses an API key stored as a header for authentication, which is required to be present with each API call made to the platform.

→ x-api-key - Your unique API keys issued to you as part of your account.

Authentication is not automated at this point, and requires manual adding to the system before you can access the resources available here.



Documentation

Cities
GET https://example.com/cities/
x-api-key: Your private key needed to access this API.
query: The query string
POST https://example.com/cities/
x-api-key: Your private key needed to access this API.
GET https://example.com/cities/{city_id}/
x-api-key: Your private key needed to access this API.
city_id: The unique id.
PUT https://example.com/cities/{city_id}/
x-api-key: Your private key needed to access this API.
city_id: The unique id.
DELETE https://example.com/cities/{city_id}/
x-api-key: Your private key needed to access this API.
city_id: The unique id.
Regions
GET https://example.com/regions/
x-api-key: Your private key needed to access this API.
query: The query string
POST https://example.com/regions/
x-api-key: Your private key needed to access this API.
GET https://example.com/regions/{region_id}/
x-api-key: Your private key needed to access this API.
region_id: The unique id.
PUT https://example.com/regions/{region_id}/
x-api-key: Your private key needed to access this API.
region_id: The unique id.
DELETE https://example.com/regions/{region_id}/
x-api-key: Your private key needed to access this API.
region_id: The unique id.
Countries
GET https://example.com/countries/
x-api-key: Your private key needed to access this API.
query: The query string
POST https://example.com/countries/
x-api-key: Your private key needed to access this API.
GET https://example.com/countries/{country_id}/
x-api-key: Your private key needed to access this API.
country_id: The unique id.
PUT https://example.com/countries/{country_id}/
x-api-key: Your private key needed to access this API.
country_id: The unique id.
DELETE https://example.com/countries/{country_id}/
x-api-key: Your private key needed to access this API.
country_id: The unique id.


Schema

cities - All cities.

  • city (array) - All of the cities being returned.

City - A city.

  • id (integer) - The unique id for the city.
  • region_id (integer) - The unique id for the region.
  • country_id (integer) - The unique id for the country.
  • latitude (number) - The latitude of the city.
  • longitude (number) - The longitude of the city.
  • name (string) - The name of the city.

Countries - All countries.

  • city (array) - All of the countries returned.

Country - A country.

  • id (integer) - The uniqud id for the country.
  • name (string) - The name of the country.
  • code (string) - The country code for this country.

regions - All regions.

  • city (array) - All of the regions being returned.

region - A region.

  • id (integer) - The unique id for the region.
  • name (string) - The name of the region.
  • code (string) - The code for the region.
  • country_id (integer) - The unique country id for the region.

- Describes an HTTP error returned

  • code (integer) - Repeat the HTTP status code
  • message (integer) - A plain language message explaining the error


Road Map


Public

This is the public version of our road map, sharing what we are doing for the foreseeable future.

  • Finish Going Through Checklist (08/06/2018) - inish going through the checklist for this service, and turn on or off each section, making as complete as possible.
  • Query and Sorting (08/06/2018) - Apply basic keyword query searching and sorting to each of the endpoints.
  • Roadmap Item (08/06/2018) - Finish the authentication for it, and allow for the setting up of a plan, applications, and keys.


Support

Email

Feel free to email us when you have any issues, and we'll work to get back to you as soon as we can.

Issues

You can submit issues to the Github repository for this service to get support regarding most of your issues.

Twitter

Feel free to Tweet at us to get your questions answered, if you don't mind making your question public.