fyi.wed.searchLocationsTypeahead Documentation (EN)

main query

Suggests up to 7 locations matching a query prefix, for typeahead use.

Parameters

query string Required

The location prefix to search for.

Output

Encodingapplication/json

locations array Required

No description available.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

query * The location prefix to search for.

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "locations"
      ],
      "properties": {
        "locations": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "name",
              "region",
              "country",
              "latitude",
              "longitude"
            ],
            "properties": {
              "name": {
                "type": "string",
                "maxLength": 256
              },
              "region": {
                "type": "string",
                "maxLength": 256
              },
              "country": {
                "type": "string",
                "maxLength": 256
              },
              "latitude": {
                "type": "integer"
              },
              "longitude": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "query"
    ],
    "properties": {
      "query": {
        "type": "string",
        "maxLength": 512,
        "description": "The location prefix to search for."
      }
    }
  },
  "description": "Suggests up to 7 locations matching a query prefix, for typeahead use."
}