Saltar al contenido
Menú de la documentación

Buscar empresas

Lista las empresas que coinciden con los filtros, primero las de mejor calidad salvo que pidas otro orden. Las filas gastan tu presupuesto diario de empresas, no tu cuota de revelaciones. domain, website y contact siguen en null hasta que hayas revelado la empresa.

GEThttps://findbytown.com/api/v1/businessesSin cuota

Parámetros

NombreTipoDescripción
countrystringCódigo de país de dos letras, como FR. Consulta GET /countries.
zonestringSlug de zona, como fr_idf. Consulta GET /zones.
citystringNombre de la ciudad en cualquier idioma: Cologne también encuentra Köln.
nearstringBúsqueda por radio como lon,lat,km, hasta 200 km. Solo coinciden las empresas con una ubicación real.
nearNamestringNombre del lugar en near: las empresas sin ubicación exacta coinciden cuando su propia dirección lo menciona.
postcodestringInicio de un código postal: 75011, o solo 75 para todos. Hasta 4, separados por comas.
deptstringCódigo de un departamento francés, como 69 para el Ródano.
polystringPolígono con vértices "lon lat" separados por punto y coma, de 3 a 60 vértices.
qstringPalabras clave, hasta 6 palabras, buscadas en nombre, descripción, dirección y categorías. Un dominio solo coincide si se escribe completo.
categorystringSlug de categoría general. Consulta GET /categories.
tradestringClave de oficio, una familia de categorías relacionadas. Consulta GET /categories.
gcatstringUna categoría exacta de la lista, sin distinguir mayúsculas.
providerown_smtp | google | microsoft | yahoo | invalid | unknownFamilia del proveedor de correo de la empresa.
providerDetailstringNombre exacto del proveedor de correo, sin distinguir mayúsculas.
hasPhonebooleantrue: solo empresas con un teléfono registrado.
noPhonebooleantrue: solo empresas sin teléfono registrado.
hasContactsbooleantrue: solo empresas con contactos con nombre.
noContactsbooleantrue: solo empresas sin contactos con nombre.
hasOtherEmailsbooleantrue: solo empresas con más de una dirección de email.
qminintegerPuntuación de calidad mínima, de 0 a 100.
qmaxintegerPuntuación de calidad máxima, de 0 a 100.
precisionstringLista separada por comas de precisiones de ubicación: exact, city, region, country.
approxbooleanfalse: solo empresas con una ubicación exacta. Valor predeterminado: true.
minRatingnumberValoración mínima, de 0 a 5.
minReviewsintegerNúmero mínimo de reseñas.
sizeClassPME | ETI | GEClase de tamaño del registro. Los datos del registro solo se conocen para algunas empresas francesas.
headcountstringUn tramo de plantilla del registro tal como está guardado, como 20-49.
minHeadcountintegerPlantilla mínima del registro: una empresa cuenta desde el inicio de su tramo.
minRevenuenumberFacturación mínima del registro, en euros.
legalFormstringForma jurídica del registro, sin distinguir mayúsculas.
sortquality | distance | rating | reviewsOrden de los resultados. distance necesita near.
bboxstringRecuadro del mapa como minLng,minLat,maxLng,maxLat.
pageintegerNúmero de página, desde 1. La última página a la que puedes llegar está en maxPage.
perPageintegerFilas por página. Un número mayor se interpreta como el máximo, y la respuesta indica cuál se aplicó.
localeen | fr | esIdioma de las etiquetas y los nombres de categoría: en, fr o es. Por defecto, el idioma de tu cuenta.

Ejemplos

curl "https://findbytown.com/api/v1/businesses?country=FR&trade=plumber&perPage=1" \
  -H "Authorization: Bearer fbt_EXAMPLE_not_a_real_key_0000"

Respuesta

Ejemplo con valores ficticios:

{
  "data": [
    {
      "id": 1001,
      "name": "Example Plumbing",
      "domain": null,
      "website": null,
      "revealed": false,
      "zone": "fr_idf",
      "country": "FR",
      "precision": "exact",
      "quality": 80,
      "provider": "google",
      "providerDetail": "Google Workspace",
      "hasPhone": true,
      "hasEmail": true,
      "contactsCount": 1,
      "otherEmailsCount": 0,
      "city": "Exampleville",
      "adminArea": "Example Region",
      "postalCode": "00000",
      "address": "1 Example Street",
      "fullAddress": "1 Example Street, 00000 Exampleville",
      "activity": "Plumber",
      "category": "Plumber",
      "categories": [
        "Heating contractor"
      ],
      "websiteTitle": null,
      "description": "Plumbing and heating repairs.",
      "mapsUrl": null,
      "rating": 4.6,
      "reviews": 25,
      "distanceM": null,
      "facts": null,
      "contact": null
    }
  ],
  "page": 1,
  "perPage": 1,
  "total": 128,
  "maxPage": 200,
  "hasMore": true,
  "capped": false
}

Errores

CódigoEstado HTTPSignificado
validation_error400Falta un parámetro o su formato es incorrecto. details indica cuál.
unknown_parameter400Este endpoint no reconoce un parámetro de consulta, normalmente por un error de escritura. details indica cuál.
use_reveal_endpoint400Has enviado reveal= en una lectura. Las lecturas nunca gastan cuota: usa el endpoint de revelación.
missing_api_key401No hay cabecera Authorization, o está vacía.
invalid_api_key401La clave no existe o ha sido revocada.
plan_without_api403El plan actual de la cuenta no incluye la API. Se aplica desde el momento en que termina un plan.
suspended403La cuenta está suspendida. Sus claves vuelven a funcionar si se levanta la suspensión.
rate_limited429Demasiadas solicitudes este minuto. Espera los segundos que indica Retry-After.
budget_exhausted429Has alcanzado el presupuesto de hoy de empresas distintas. Las empresas ya vistas hoy siguen pasando. Retry-After indica cuándo se reinicia.
blocked429El acceso a los datos de empresas está temporalmente en pausa por uso automatizado, como recorrer ids. Retry-After indica el tiempo restante. Escribe a soporte si es un error.
internal_error500Algo ha fallado por nuestra parte. Indica requestId al escribir a soporte.

Volver a findbytown