Quickstart

Sign up. Create an account in the dashboard and verify your email. You do not need a Graphite Lab subscription. A new account has zero rivets, and the playground and docs work right away.

Buy rivets. Open the Overview page and buy a pack, from $50 for 10,000 rivets. A rivet costs half a cent, see Pricing.

Create a key. Open the API keys page in the dashboard and create a key. Copy it now; it is shown once.

Make your first request. Forward geocode the White House. Send the key as a Bearer token:

curl -si "https://api.data.graphitelab.ai/v1/geocode/search?text=1600%20Pennsylvania%20Ave%20NW%2C%20Washington%2C%20DC%2020500" \
  -H "Authorization: Bearer $GRAPHITE_API_KEY"

Or send it as the apiKey query parameter:

curl -si "https://api.data.graphitelab.ai/v1/geocode/search?text=Ottawa&apiKey=$GRAPHITE_API_KEY"

Read your balance. Every response carries an X-Rivets-Remaining header with the rivets left after the request (-i above prints headers):

X-Rivets-Remaining: 4999

The response body is a GeoJSON FeatureCollection (trimmed):

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "country_code": "us",
        "state_code": "DC",
        "city": "Washington",
        "postcode": "20500",
        "housenumber": "1600",
        "formatted": "1600 PENNSYLVANIA Avenue Northwest, Washington, DC 20500, United States",
        "result_type": "building",
        "datasource": { "sourcename": "nad+overture" },
        "rank": { "confidence": 1, "match_type": "full_match" },
        "place_id": "gp:addr:canonical:37388970"
      },
      "geometry": { "type": "Point", "coordinates": [-77.03654697024702, 38.89767510742324] }
    }
  ]
}

See Authentication for errors and limits. Read the deviation notes on the endpoints you use (see Concepts).