gateway.apiosk.com

{
  "input": {
    "discoverable": true,
    "method": "GET",
    "queryParams": {
      "properties": {
        "country": {
          "description": "Comma-separated ISO 3166-1 alpha-2 country codes to limit results to.",
          "example": "US",
          "type": "string"
        },
        "limit": {
          "description": "Maximum number of results to return (1-10, default 5).",
          "example": 5,
          "type": "integer"
        },
        "proximity": {
          "description": "\"longitude,latitude\" pair used to bias forward-geocoding results toward a location.",
          "example": "-122.42,37.78",
          "type": "string"
        },
        "q": {
          "description": "Search query. For forward geocoding, a place name or address (e.g. \"San Francisco\"). For reverse geocoding, a \"longitude,latitude\" coordinate pair.",
          "example": "San Francisco",
          "type": "string"
        },
        "types": {
          "description": "Comma-separated list of feature types to filter results to (e.g. place, address, poi, region, country, postcode).",
          "example": "place,address",
          "type": "string"
        }
      },
      "required": [
        "q"
      ],
      "type": "object"
    },
    "type": "http"
  },
  "output": {
    "features": [
      {
        "geometry": {
          "coordinates": [
            -122.419359,
            37.779238
          ],
          "type": "Point"
        },
        "id": "dXJuOm1ieHBsYzpFVzBJN0E",
        "properties": {
          "context": {
            "country": {
              "country_code": "US",
              "country_code_alpha_3": "USA",
              "mapbox_id": "dXJuOm1ieHBsYzpJdXc",
              "name": "United States",
              "wikidata_id": "Q30"
            },
            "district": {
              "mapbox_id": "dXJuOm1ieHBsYzpBVG1HN0E",
              "name": "San Francisco County",
              "wikidata_id": "Q62"
            },
            "place": {
              "mapbox_id": "dXJuOm1ieHBsYzpFVzBJN0E",
              "name": "San Francisco",
              "wikidata_id": "Q62"
            },
            "region": {
              "mapbox_id": "dXJuOm1ieHBsYzpCbVRz",
              "name": "California",
              "region_code": "CA",
              "region_code_full": "US-CA",
              "wikidata_id": "Q99"
            }
          },
          "coordinates": {
            "latitude": 37.779238,
            "longitude": -122.419359
          },
          "feature_type": "place",
          "full_address": "San Francisco, California, United States",
          "mapbox_id": "dXJuOm1ieHBsYzpFVzBJN0E",
          "name": "San Francisco",
          "name_preferred": "San Francisco",
          "place_formatted": "California, United States"
        },
        "type": "Feature"
      }
    ],
    "type": "FeatureCollection"
  }
}