Tool reference
Search location/language reference
Resolve a human-readable location or language name into the DataForSEO reference object ({ id, code, isoCode, name }) required by campaign/workspace writes.
Tool name: search_reference
Cost: Free - not billed, and does not draw on a plan quota.
Read-only
This tool only reads. It never creates or changes anything, so an assistant may call it without asking you first.
Resolve a human-readable location or language name into the DataForSEO reference object ({ id, code, isoCode, name }) required by campaign/workspace writes. Call this to obtain a location/language/defaultLocation/defaultLanguage value - never invent those ids. Pass a chosen result object through verbatim. Locations are restricted to countries.
Parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
type | "location" | "language" | Yes | - |
query | string | No | Name prefix to search, e.g. "United States" or "English". Omit to list the first results. |
limit | integer | No | Defaults to 10. |
Full input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["location", "language"]
},
"query": {
"description": "Name prefix to search, e.g. \"United States\" or \"English\". Omit to list the first results.",
"type": "string"
},
"limit": {
"default": 10,
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 50
}
},
"required": ["type"]
}Response
Full output JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"query": {
"type": "string"
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"code": {
"type": "string"
},
"isoCode": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": ["id", "code", "isoCode", "name"],
"additionalProperties": {}
}
}
},
"required": ["type", "query", "results"],
"additionalProperties": false
}