Good Enough Maps Documentation

Build powerful location-based applications with ease. Let's get you started!

Getting Started

1
Create Your Account
Sign up for a free API account to start using our services.
Go to sign-up page →
2
Get Your API Key
Obtain your API key from the API Keys section.
View API Keys →
3
Make Your First API Call
Check our API Reference for details on how to use our endpoints.
View API Reference →

Authentication

Using Your API Key

Include your API key in the Authorization header for every request as a Bearer token.

Authorization: Bearer YOUR_API_KEY

Protecting Your API Key

Keep your API key confidential. Don't expose it in client-side code or public repositories. Use environment variables to store your key securely.

API Reference

Places Search Endpoint

Use our main search endpoint to find places based on various criteria.

GET https://api.goodenoughmaps.com/api/places

Example API call:

curl -X GET "https://api.goodenoughmaps.com/api/places?query=coffee" -H "Authorization: Bearer YOUR_API_KEY"

View Parameters

Search Parameters

Customize your search with these query parameters.

Parameter	Type	Description
query	string	The search term
latitude	number	Latitude for location-based search
longitude	number	Longitude for location-based search
limit	number	Maximum number of results (default: 10, max: 100)
country	string	Filter by country (comma-separated)
category	string	Filter by category (comma-separated)
city	string	Filter by city (comma-separated)
state	string	Filter by state (comma-separated)

Filtering

Refine your search results with powerful filtering options.

Use country, state, and city parameters to narrow down results to specific geographic areas.

Response Format

Understanding the structure of API responses.

JSON Response Structure

Our API returns results in JSON format. Here's an example response:

[
  {
    "id": "string",
    "primary_name": "string",
    "version": number,
    "update_time": "string (ISO 8601)",
    "categories": {
      "main": "string",
      "alternate": ["string"]
    },
    "confidence": number,
    "websites": ["string"],
    "socials": ["string"],
    "emails": ["string"],
    "phones": ["string"],
    "brand_wikidata": "string",
    "address": {
      "freeform": "string",
      "locality": "string",
      "postcode": "string",
      "region": "string",
      "country": "string"
    },
    "sources": ["string"]
  }
]