POST
/explore/lite
Restituisce una lista di aziende filtrando il database delle fonti ufficiali tramite i filtri specificati. La risposta è sempre paginata a 25 elementi per pagina.
Request Body
Campo |
Tipo |
Descrizione |
filters |
ExploreFilters |
Oggetto filtri per la ricerca aziende (vedi dettagli sotto).
Vedi dettagli oggetto ExploreFilters sotto.
|
page |
Int |
Numero pagina (opzionale, default 1)
|
ExploreFilters
Campo |
Tipo |
Descrizione |
countriesIso2 |
String[] |
Codici ISO2 della nazione (obbligatorio). I valori disponibili sono quelli supportati dall'API. Il limite di nazioni è 1 per Lite e Plus, 5 per Simple Semantic.
|
regions |
String[] |
Elenco delle regioni da includere nel filtro. I valori disponibili si ottengono da un endpoint dedicato passando il country.. Vedi qui
|
cities |
String[] |
Elenco delle città da includere nel filtro. I valori disponibili si ottengono da un endpoint dedicato passando il country.. Vedi qui
|
postcode |
String[] |
Elenco di codici postali da includere nel filtro
|
dateOfIncorporationGte |
DateTime |
Data di costituzione azienda (maggiore o uguale a)
|
dateOfIncorporationLte |
DateTime |
Data di costituzione azienda (minore o uguale a)
|
operatingRevenueGte |
Int |
Fatturato minimo (in valuta locale)
|
operatingRevenueLte |
Int |
Fatturato massimo (in valuta locale)
|
numberOfEmployeesLte |
Int |
Numero massimo di dipendenti
|
numberOfEmployeesGte |
Int |
Numero minimo di dipendenti
|
standardisedLegalForm |
String[] |
Elenco di forme giuridiche standardizzate
|
nationalSectors |
String[] |
Codici settoriali nazionali. I valori disponibili si ottengono da un endpoint dedicato passando il country.. Vedi qui
|
naceCodes |
String[] |
Codici NACE da includere nel filtro. I valori disponibili si ottengono da un endpoint dedicato.. Vedi qui
|
naicsCodes |
String[] |
Codici NAICS da includere nel filtro. I valori disponibili si ottengono da un endpoint dedicato.. Vedi qui
|
sicCodes |
String[] |
Codici SIC da includere nel filtro. I valori disponibili si ottengono da un endpoint dedicato.. Vedi qui
|
isPrimaryCodes |
Boolean |
Filtra codici primari (true/false)
|
isSecondaryCodes |
Boolean |
Filtra codici secondari (true/false)
|
categories |
String[] |
Categorie personalizzate da includere nel filtro. I valori corrispondono a categoryOfTheCompany dell'oggetto company.. Vedi Oggetto Azienda (categoryOfTheCompany)
|
status |
String[] |
Status aziendali da includere. I valori corrispondono a status dell'oggetto company.. Vedi Oggetto Azienda (status)
|
listedDelistedUnlisted |
String[] |
Stato di quotazione (quotata, delistata, non quotata)
|
Risposta 200
Campo |
Tipo |
Descrizione |
companies |
Company[] |
Array di aziende trovate (max 25 per pagina) |
totalCompanies |
Int |
Numero totale di aziende trovate |
totalPages |
Int |
Numero totale di pagine |
page |
Int |
Numero pagina corrente |
pageSize |
Int |
Dimensione pagina (fisso 25) |
searchContextId |
String |
Identificativo del contesto di ricerca |
input |
Object |
Parametri di input ricevuti |
Company
Vedi la sezione Oggetto Azienda per la descrizione dettagliata dei campi company.
Altri codici
400
–
Spiegazione dell'errore
{
"error": "Missing required filter param countryIso2"
}
Esempio
{
"companies": [],
"totalCompanies": 0,
"totalPages": 1,
"page": 1,
"pageSize": 25,
"searchContextId": "b7e6a2c1-4f3d-4e2a-9c1a-2b3e4d5f6a7b"
}
Esempio chiamata curl
curl -X POST "/explore/lite" \
-H "x-api-key: <API_KEY>" \
-H "Content-Type: application/json" \
-d '{
"filters": {
"countriesIso2": ["IT"],
"naceCodes": ["62.01"],
"naicsCodes": [],
"sicCodes": [],
"nationalCodes": [],
"region": "",
"postCode": "",
"companyStatus": ""
},
"page": 1
}'