Buscar ciudades
Busca nuestras ciudades para filtrar empresas en una ubicación específica.
GET
https://api.thecompaniesapi.com/v2/locations/cities
Gratis
Si necesitas filtrar empresas por ciudad, puedes usar esta función para obtener información como su código.
Regístrate para acceder a todas las características
Obtén tu token de API y comienza a implementar la API en tu producto con 500 créditos gratuitos.
No se requiere tarjeta de crédito
Parámetros de consulta
pagenumber (opcional)
La página a obtener (por defecto 1).
searchstring (opcional)
Una consulta de búsqueda adicional aplicada al nombre de la ciudad.
sizenumber (opcional)
El número de ciudades a devolver (entre 1 y 20). Por defecto 10.
Esquema de respuesta
citiesarray
Las ciudades que coinciden con tus condiciones.
metaobject
La información de metadatos.
Ejemplos de código
Selecciona tu lenguaje favorito:
import createClient from '@thecompaniesapi/sdk'
const tca = createClient({ apiToken: 'YOUR_API_TOKEN' })
const response = await tca.searchCities({
search: 'new york',
size: 5
})
const cities = response.data.cities // Cities that match the name
const meta = response.data.meta // Meta information