Quick Start

1. Get Your API Key

First, you need an API key.

• If you have an account, go to the access page in the dashboard
• If you don’t have an account yet, sign up first and then go to the access page in the dashboard

All requests are authenticated by passing your key in a header field called API-KEY.

API Key Types

2. Make Your First API Call

Let's perform the kind of search that's impossible with other APIs: Find a top-rated coffee shop halfway between two people.

Copy the curl command below, replace YOUR_API_KEY with the key you just generated, and run it in your terminal.

curl -X POST https://api.inbe.us/v1/search \\
  -H "Content-Type: application/json" \\
  -H "API-KEY: YOUR_API_KEY" \\
  -d '{
    "mode": "midpoint",
    "locations": [
      { "lat": 51.5072, "lon": -0.1276 },
      { "lat": 51.5154, "lon": -0.1419 }
    ],
    "preferences": {
      "establishment": ["coffee_shop"],
      "nonCompromise": {
        "rating": 4.5
      }
    }
  }'

3. See the Result

You'll get back a clean JSON response with a list of perfectly matched locations, enriched with InBe's deep data.

{
  "results": [
    {
      "id": "place_123abc",
      "name": "The Grind",
      "rating": 4.8,
      "location": {
        "address": "123 Fleet Street, London, EC4A 2BE",
        "lat": 51.5113,
        "lon": -0.1347
      },
      "travel": {
        "from_user_1": { "duration_mins": 12, "distance_km": 1.8 },
        "from_user_2": { "duration_mins": 11, "distance_km": 1.6 }
      },
      "open_now": true
    }
  ],
  "pagination": {
    "total_results": 1,
    "limit": 20,
    "offset": 0
  }
}