Cities Lookup API Reference

API Overview

Cities Lookup is a simple tool for looking up city data. It returns the city name, population, and more. To use this API, you need an API key. You can get one by creating a free account and visiting your dashboard.

Important: Ensure that this API is enabled from within your dashboard to use it in your application. If not, you may receive a 403 error

View API in Directory

Client Libaries

To get started with minimal code, most of our APIs are available through client libraries:

run in postman button npm logo pypi logo nuget logo

Lookup City

1 Token

Lookup city data based on the city name

	
#GET Request
https://api.apiverve.com/v1/citieslookup?city=San Francisco	

	
					

x-api-key (required)

This is a required header on every request. Your API Key is found from within your dashboard

accept

This is an optional header. Set the value to application/json, application/xml, or application/yaml


citystring(required)

The city name for which you want to get the data (e.g., New York)


Sample Request
	
import requests

url = "https://api.apiverve.com/v1/citieslookup"

querystring = {'city': 'San Francisco'}

headers = {
	"x-api-key": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
	
							
	
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
	Method = HttpMethod.Get,
	RequestUri = new Uri("https://api.apiverve.com/v1/citieslookup?city=San Francisco"),
	Headers =
	{
		{ "x-api-key", "YOUR_API_KEY" }
	},
};
using (var response = await client.SendAsync(request))
{
	response.EnsureSuccessStatusCode();
	var body = await response.Content.ReadAsStringAsync();
	Console.WriteLine(body);
}
	
							
	
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open('GET', 'https://api.apiverve.com/v1/citieslookup?city=San Francisco');
xhr.setRequestHeader('x-api-key', 'YOUR_API_KEY');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Accept', 'application/json');

xhr.send(data);
	
							
	
const request = require('request');

const options = {
  method: 'GET',
  url: 'https://api.apiverve.com/v1/citieslookup?city=San Francisco',
  headers: {
    'x-api-key': 'YOUR_API_KEY'
  }
};

request(options, function (error, response, body) {
	if (error) throw new Error(error);

	console.log(body);
});
	
							
	
HttpRequest request = HttpRequest.newBuilder()
		.uri(URI.create("https://api.apiverve.com/v1/citieslookup?city=San Francisco"))
		.header("x-api-key", "YOUR_API_KEY")
		.method("GET", HttpRequest.BodyPublishers.noBody())
		.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
	
							
	
import Foundation

let headers = [
	"x-api-key": "YOUR_API_KEY"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.apiverve.com/v1/citieslookup?city=San Francisco")! as URL,
				cachePolicy: .useProtocolCachePolicy,
                timeoutInterval: 10.0)

request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
	if (error != nil) {
		print(error as Any)
	} else {
		let httpResponse = response as? HTTPURLResponse
		print(httpResponse)
	}
})

dataTask.resume()
	
							
	
curl --request GET \
	--url 'https://api.apiverve.com/v1/citieslookup?city=San Francisco' \
	--header 'x-api-key: YOUR_API_KEY'
	
							

Sample Response
	
{
  "status": "ok",
  "error": null,
  "data": {
    "search": "San Francisco",
    "foundCities": [
      {
        "name": "San Francisco",
        "altName": "",
        "country": "US",
        "featureCode": "PPLA2",
        "population": 864816,
        "loc": {
          "type": "Point",
          "coordinates": [
            -122.41942,
            37.77493
          ]
        }
      },
      {
        "name": "San Francisco de Macorís",
        "altName": "",
        "country": "DO",
        "featureCode": "PPLA",
        "population": 124763,
        "loc": {
          "type": "Point",
          "coordinates": [
            -70.25259,
            19.30099
          ]
        }
      },
      {
        "name": "San Francisco del Rincón",
        "altName": "",
        "country": "MX",
        "featureCode": "PPLA2",
        "population": 71139,
        "loc": {
          "type": "Point",
          "coordinates": [
            -101.85515,
            21.01843
          ]
        }
      },
      {
        "name": "South San Francisco",
        "altName": "",
        "country": "US",
        "featureCode": "PPL",
        "population": 67271,
        "loc": {
          "type": "Point",
          "coordinates": [
            -122.40775,
            37.65466
          ]
        }
      },
      {
        "name": "San Francisco",
        "altName": "",
        "country": "AR",
        "featureCode": "PPLA2",
        "population": 59062,
        "loc": {
          "type": "Point",
          "coordinates": [
            -62.08266,
            -31.42797
          ]
        }
      },
      {
        "name": "San Francisco",
        "altName": "",
        "country": "CR",
        "featureCode": "PPL",
        "population": 55923,
        "loc": {
          "type": "Point",
          "coordinates": [
            -84.12934,
            9.99299
          ]
        }
      },
      {
        "name": "San Francisco El Alto",
        "altName": "",
        "country": "GT",
        "featureCode": "PPLA2",
        "population": 54493,
        "loc": {
          "type": "Point",
          "coordinates": [
            -91.4431,
            14.9449
          ]
        }
      },
      {
        "name": "San Francisco Acuautla",
        "altName": "",
        "country": "MX",
        "featureCode": "PPL",
        "population": 27960,
        "loc": {
          "type": "Point",
          "coordinates": [
            -98.86034,
            19.34564
          ]
        }
      },
      {
        "name": "San Francisco Cuaxusco",
        "altName": "",
        "country": "MX",
        "featureCode": "PPLX",
        "population": 24900,
        "loc": {
          "type": "Point",
          "coordinates": [
            -99.61925,
            19.26755
          ]
        }
      },
      {
        "name": "San Francisco Tlalcilalcalpan",
        "altName": "",
        "country": "MX",
        "featureCode": "PPL",
        "population": 16509,
        "loc": {
          "type": "Point",
          "coordinates": [
            -99.76771,
            19.29474
          ]
        }
      },
      {
        "name": "San Francisco",
        "altName": "",
        "country": "SV",
        "featureCode": "PPLA",
        "population": 16152,
        "loc": {
          "type": "Point",
          "coordinates": [
            -88.1,
            13.7
          ]
        }
      },
      {
        "name": "San Francisco de los Romo",
        "altName": "",
        "country": "MX",
        "featureCode": "PPLA2",
        "population": 16124,
        "loc": {
          "type": "Point",
          "coordinates": [
            -102.2714,
            22.07748
          ]
        }
      },
      {
        "name": "San Francisco Zapotitlán",
        "altName": "",
        "country": "GT",
        "featureCode": "PPLA2",
        "population": 13855,
        "loc": {
          "type": "Point",
          "coordinates": [
            -91.52144,
            14.58939
          ]
        }
      },
      {
        "name": "San Francisco Ocotlán",
        "altName": "",
        "country": "MX",
        "featureCode": "PPL",
        "population": 11636,
        "loc": {
          "type": "Point",
          "coordinates": [
            -98.28345,
            19.13411
          ]
        }
      },
      {
        "name": "San Francisco Tecoxpa",
        "altName": "",
        "country": "MX",
        "featureCode": "PPL",
        "population": 11456,
        "loc": {
          "type": "Point",
          "coordinates": [
            -99.00639,
            19.19167
          ]
        }
      },
      {
        "name": "San Francisco Telixtlahuaca",
        "altName": "",
        "country": "MX",
        "featureCode": "PPLA2",
        "population": 10618,
        "loc": {
          "type": "Point",
          "coordinates": [
            -96.90529,
            17.29684
          ]
        }
      },
      {
        "name": "San Francisco Tetlanohcan",
        "altName": "",
        "country": "MX",
        "featureCode": "PPLA2",
        "population": 9858,
        "loc": {
          "type": "Point",
          "coordinates": [
            -98.1637,
            19.2602
          ]
        }
      },
      {
        "name": "San Francisco Chimalpa",
        "altName": "",
        "country": "MX",
        "featureCode": "PPL",
        "population": 8953,
        "loc": {
          "type": "Point",
          "coordinates": [
            -99.34398,
            19.44279
          ]
        }
      },
      {
        "name": "Altos de San Francisco",
        "altName": "",
        "country": "PA",
        "featureCode": "PPL",
        "population": 8189,
        "loc": {
          "type": "Point",
          "coordinates": [
            -79.79,
            8.86167
          ]
        }
      },
      {
        "name": "San Francisco Zacacalco",
        "altName": "",
        "country": "MX",
        "featureCode": "PPL",
        "population": 7420,
        "loc": {
          "type": "Point",
          "coordinates": [
            -98.98279,
            19.92875
          ]
        }
      }
    ]
  },
  "code": 200
}
	
							
	
<Root>
  <status>ok</status>
  <error />
  <data>
    <search>San Francisco</search>
    <foundCities>
      <name>San Francisco</name>
      <altName></altName>
      <country>US</country>
      <featureCode>PPLA2</featureCode>
      <population>864816</population>
      <loc>
        <type>Point</type>
        <coordinates>-122.41942</coordinates>
        <coordinates>37.77493</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco de Macorís</name>
      <altName></altName>
      <country>DO</country>
      <featureCode>PPLA</featureCode>
      <population>124763</population>
      <loc>
        <type>Point</type>
        <coordinates>-70.25259</coordinates>
        <coordinates>19.30099</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco del Rincón</name>
      <altName></altName>
      <country>MX</country>
      <featureCode>PPLA2</featureCode>
      <population>71139</population>
      <loc>
        <type>Point</type>
        <coordinates>-101.85515</coordinates>
        <coordinates>21.01843</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>South San Francisco</name>
      <altName></altName>
      <country>US</country>
      <featureCode>PPL</featureCode>
      <population>67271</population>
      <loc>
        <type>Point</type>
        <coordinates>-122.40775</coordinates>
        <coordinates>37.65466</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco</name>
      <altName></altName>
      <country>AR</country>
      <featureCode>PPLA2</featureCode>
      <population>59062</population>
      <loc>
        <type>Point</type>
        <coordinates>-62.08266</coordinates>
        <coordinates>-31.42797</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco</name>
      <altName></altName>
      <country>CR</country>
      <featureCode>PPL</featureCode>
      <population>55923</population>
      <loc>
        <type>Point</type>
        <coordinates>-84.12934</coordinates>
        <coordinates>9.99299</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco El Alto</name>
      <altName></altName>
      <country>GT</country>
      <featureCode>PPLA2</featureCode>
      <population>54493</population>
      <loc>
        <type>Point</type>
        <coordinates>-91.4431</coordinates>
        <coordinates>14.9449</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco Acuautla</name>
      <altName></altName>
      <country>MX</country>
      <featureCode>PPL</featureCode>
      <population>27960</population>
      <loc>
        <type>Point</type>
        <coordinates>-98.86034</coordinates>
        <coordinates>19.34564</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco Cuaxusco</name>
      <altName></altName>
      <country>MX</country>
      <featureCode>PPLX</featureCode>
      <population>24900</population>
      <loc>
        <type>Point</type>
        <coordinates>-99.61925</coordinates>
        <coordinates>19.26755</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco Tlalcilalcalpan</name>
      <altName></altName>
      <country>MX</country>
      <featureCode>PPL</featureCode>
      <population>16509</population>
      <loc>
        <type>Point</type>
        <coordinates>-99.76771</coordinates>
        <coordinates>19.29474</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco</name>
      <altName></altName>
      <country>SV</country>
      <featureCode>PPLA</featureCode>
      <population>16152</population>
      <loc>
        <type>Point</type>
        <coordinates>-88.1</coordinates>
        <coordinates>13.7</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco de los Romo</name>
      <altName></altName>
      <country>MX</country>
      <featureCode>PPLA2</featureCode>
      <population>16124</population>
      <loc>
        <type>Point</type>
        <coordinates>-102.2714</coordinates>
        <coordinates>22.07748</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco Zapotitlán</name>
      <altName></altName>
      <country>GT</country>
      <featureCode>PPLA2</featureCode>
      <population>13855</population>
      <loc>
        <type>Point</type>
        <coordinates>-91.52144</coordinates>
        <coordinates>14.58939</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco Ocotlán</name>
      <altName></altName>
      <country>MX</country>
      <featureCode>PPL</featureCode>
      <population>11636</population>
      <loc>
        <type>Point</type>
        <coordinates>-98.28345</coordinates>
        <coordinates>19.13411</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco Tecoxpa</name>
      <altName></altName>
      <country>MX</country>
      <featureCode>PPL</featureCode>
      <population>11456</population>
      <loc>
        <type>Point</type>
        <coordinates>-99.00639</coordinates>
        <coordinates>19.19167</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco Telixtlahuaca</name>
      <altName></altName>
      <country>MX</country>
      <featureCode>PPLA2</featureCode>
      <population>10618</population>
      <loc>
        <type>Point</type>
        <coordinates>-96.90529</coordinates>
        <coordinates>17.29684</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco Tetlanohcan</name>
      <altName></altName>
      <country>MX</country>
      <featureCode>PPLA2</featureCode>
      <population>9858</population>
      <loc>
        <type>Point</type>
        <coordinates>-98.1637</coordinates>
        <coordinates>19.2602</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco Chimalpa</name>
      <altName></altName>
      <country>MX</country>
      <featureCode>PPL</featureCode>
      <population>8953</population>
      <loc>
        <type>Point</type>
        <coordinates>-99.34398</coordinates>
        <coordinates>19.44279</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>Altos de San Francisco</name>
      <altName></altName>
      <country>PA</country>
      <featureCode>PPL</featureCode>
      <population>8189</population>
      <loc>
        <type>Point</type>
        <coordinates>-79.79</coordinates>
        <coordinates>8.86167</coordinates>
      </loc>
    </foundCities>
    <foundCities>
      <name>San Francisco Zacacalco</name>
      <altName></altName>
      <country>MX</country>
      <featureCode>PPL</featureCode>
      <population>7420</population>
      <loc>
        <type>Point</type>
        <coordinates>-98.98279</coordinates>
        <coordinates>19.92875</coordinates>
      </loc>
    </foundCities>
  </data>
  <code>200</code>
</Root>
	
							
	
status: ok
error: 
data:
  search: San Francisco
  foundCities:
  - name: San Francisco
    altName: ''
    country: US
    featureCode: PPLA2
    population: 864816
    loc:
      type: Point
      coordinates:
      - -122.41942
      - 37.77493
  - name: San Francisco de Macorís
    altName: ''
    country: DO
    featureCode: PPLA
    population: 124763
    loc:
      type: Point
      coordinates:
      - -70.25259
      - 19.30099
  - name: San Francisco del Rincón
    altName: ''
    country: MX
    featureCode: PPLA2
    population: 71139
    loc:
      type: Point
      coordinates:
      - -101.85515
      - 21.01843
  - name: South San Francisco
    altName: ''
    country: US
    featureCode: PPL
    population: 67271
    loc:
      type: Point
      coordinates:
      - -122.40775
      - 37.65466
  - name: San Francisco
    altName: ''
    country: AR
    featureCode: PPLA2
    population: 59062
    loc:
      type: Point
      coordinates:
      - -62.08266
      - -31.42797
  - name: San Francisco
    altName: ''
    country: CR
    featureCode: PPL
    population: 55923
    loc:
      type: Point
      coordinates:
      - -84.12934
      - 9.99299
  - name: San Francisco El Alto
    altName: ''
    country: GT
    featureCode: PPLA2
    population: 54493
    loc:
      type: Point
      coordinates:
      - -91.4431
      - 14.9449
  - name: San Francisco Acuautla
    altName: ''
    country: MX
    featureCode: PPL
    population: 27960
    loc:
      type: Point
      coordinates:
      - -98.86034
      - 19.34564
  - name: San Francisco Cuaxusco
    altName: ''
    country: MX
    featureCode: PPLX
    population: 24900
    loc:
      type: Point
      coordinates:
      - -99.61925
      - 19.26755
  - name: San Francisco Tlalcilalcalpan
    altName: ''
    country: MX
    featureCode: PPL
    population: 16509
    loc:
      type: Point
      coordinates:
      - -99.76771
      - 19.29474
  - name: San Francisco
    altName: ''
    country: SV
    featureCode: PPLA
    population: 16152
    loc:
      type: Point
      coordinates:
      - -88.1
      - 13.7
  - name: San Francisco de los Romo
    altName: ''
    country: MX
    featureCode: PPLA2
    population: 16124
    loc:
      type: Point
      coordinates:
      - -102.2714
      - 22.07748
  - name: San Francisco Zapotitlán
    altName: ''
    country: GT
    featureCode: PPLA2
    population: 13855
    loc:
      type: Point
      coordinates:
      - -91.52144
      - 14.58939
  - name: San Francisco Ocotlán
    altName: ''
    country: MX
    featureCode: PPL
    population: 11636
    loc:
      type: Point
      coordinates:
      - -98.28345
      - 19.13411
  - name: San Francisco Tecoxpa
    altName: ''
    country: MX
    featureCode: PPL
    population: 11456
    loc:
      type: Point
      coordinates:
      - -99.00639
      - 19.19167
  - name: San Francisco Telixtlahuaca
    altName: ''
    country: MX
    featureCode: PPLA2
    population: 10618
    loc:
      type: Point
      coordinates:
      - -96.90529
      - 17.29684
  - name: San Francisco Tetlanohcan
    altName: ''
    country: MX
    featureCode: PPLA2
    population: 9858
    loc:
      type: Point
      coordinates:
      - -98.1637
      - 19.2602
  - name: San Francisco Chimalpa
    altName: ''
    country: MX
    featureCode: PPL
    population: 8953
    loc:
      type: Point
      coordinates:
      - -99.34398
      - 19.44279
  - name: Altos de San Francisco
    altName: ''
    country: PA
    featureCode: PPL
    population: 8189
    loc:
      type: Point
      coordinates:
      - -79.79
      - 8.86167
  - name: San Francisco Zacacalco
    altName: ''
    country: MX
    featureCode: PPL
    population: 7420
    loc:
      type: Point
      coordinates:
      - -98.98279
      - 19.92875
code: 200

	
							
Live Test API in Playground

Response Types

The Cities Lookup API supports the following response content types:

application/json, application/xml, application/yaml

You can specify the response content type by setting the Accept header in your request. If you don't specify a content type, the API will default to application/json.

Authentication

The Cities Lookup API uses an API Key to authenticate requests. You can view and manage your API key by visiting your dashboard.

Your API keys carry many privileges. To keep them from being abused, please do not share the keys on client-side code or Github etc. Keep them very secure.

To use any API, you must have it enabled from within your dashboard. Disabled APIs will fail to respond to your requests.

All requests made to the API must contain the header x-api-key in each of your requests. API requests without authentication will fail.

All API requests must also be made over secure HTTPS. Requests made over plain HTTP will fail.

Error Code Meaning
401 Your request was made with invalid credentials. This error also appears when you don't pass the x-api-key header in your request.
403 Typically, this occurs when you are trying to access an API that you have not enabled.

Rate Limits

	
{
    "status": "error",
    "data": null,
    "error": "tokens have been depleted",
    "code": 429
}
	
							

Each subscription has its own monthly token limit. Your token count is based on your subscription plan. If you reach your limits, don't worry. You can always upgrade or downgrade at any time.

When you reach your limit, the service will stop responding and typically return an HTTP 429 response status code. The error will also contain a detailed JSON.

The Cities Lookup API uses the following error code:

Error Code Meaning
429 You have exceeded your rate limit and further requests will be denied until the next cycle.

Error Codes

For reference, the Cities Lookup API uses the following error codes:

Error Code Meaning
Code Message
200 The request was successful. The response will include the requested data.
400 The request was invalid. The response will include a message that explains the error.
401 The request was not authorized. Usually, this means that the API key is missing or invalid.
403 This means that the request was trying to access a resource that it does not have permission to access.
404 This means that the resource you are trying to access does not exist.
429 This means that you have reached the rate limit. The response will include a Retry-After header that indicates how many seconds you need to wait before making a new request.
500 This means that there was an error on the server side. We are alerted when this happens and we will work to fix it as soon as possible.
ON THIS PAGE