Skip to content
Get started

Quickstart

From your API key to your first answer, in a minute.

  1. Get your API key

    It is in the app, under API. Keep it in an environment variable, never in your code:

    export LOBSTR_API_KEY="your_api_key"
  2. Run an operation

    One call, POST /v2/run, with the operation and its options. Here google_maps/places/get, one place on Google Maps by its name and city:

    curl https://api.lobstr.io/v2/run \
      -H "Authorization: Bearer $LOBSTR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "source": "google_maps",
        "operation": "places/get",
        "options": {
          "place": "Le Bouchon des Filles, Lyon"
        }
      }'
  3. Read the answer

    The data is in the answer: no job to poll, no webhook to wait for. Shortened:

    {
      "object": "run",
      "id": "run_p4mhm5p5yff6hghsas6wqpwusa",
      "source": "google_maps",
      "operation": "places/get",
      "status": "succeeded",
      "count": 1,
      "has_more": false,
      "next": null,
      "cost": {
        "credits": 1
      },
      "duration_ms": 1652,
      "results": [
        {
          "object": "place",
          "name": "Le Bouchon des Filles",
          "phone": "+33478304044",
          "rating": {
            "value": 4.6,
            "scale": 5,
            "count": 2237
          }
        }
      ]
    }

A failed call is free, and so is a place that is not found: you pay for the data you get.