Rechercher des régions
Rechercher nos régions pour filtrer nos entreprises dans un lieu spécifique.
GET
https://api.thecompaniesapi.com/v2/locations/states
Gratuit
Si vous devez filtrer les entreprises par région, vous pouvez utiliser cette fonctionnalité pour récupérer des informations comme leur code.
Inscrivez-vous pour accéder à toutes les fonctionnalités
Recevez votre jeton d'API et commencez à implémenter l'API dans votre produit avec 500 crédits gratuits.
Aucune carte de crédit requise
Paramètres de requête
pagenumber (optionnel)
La page à récupérer (par défaut 1).
searchstring (optionnel)
Une recherche additionnelle appliquée au nom de la région.
sizenumber (optionnel)
Le nombre d'états à retourner (entre 1 et 20). Par défaut 10.
Schéma de réponse
statesarray
Les états qui correspondent à vos critères.
metaobject
Les informations sur les métas.
Exemples de code
Sélectionnez votre langage favori :
import createClient from '@thecompaniesapi/sdk'
const tca = createClient({ apiToken: 'YOUR_API_TOKEN' })
const response = await tca.searchStates({
search: 'california',
size: 5
})
const states = response.data.states // States that match the name
const meta = response.data.meta // Meta information