Comuni Docs

Getting Started

Richiesta Token

per richiedere il token di accesso di utilizzo della API basta registrarsi al link comuni.alessiopellizzaro.it andare sulla pagina "#Api" e clicare su "add new"

una volta fatto si potra inizare ad utilizzare il token ottenuto per le richieste

Essempio di richiesta

curl --location 'https://comuni.alessiopellizzaro.it/api/v2/comuni?$filter=Denominazione eq Milano' \
--header 'Authorization: Bearer {{YOUR_TOKEN}}

risultato richiesta

{
    "success": true,
    "message": "Comuni ottenuti con successo.",
    "records": 1,
    "comuni": [
        {
            "CodiceRegione": 3,
            "CodicedellUnitaTerritorialeSovracomunale_Storico_1": null,
            "ProgressivoDelComune": 146,
            "CodiceComuneFormatoAlfanumerico": "015146",
            "Denominazione": "Milano",
            "DenominazioneIt": "Milano",
            "DenominazioneOther": null,
            "CodiceRipartizioneGeografica": "1",
            "RipartizioneGeografica": "Nord-ovest",
            "Regione": "Lombardia",
            "DenominazioneDellUnitàTerritorialeSovracomunale": null,
            "TipologiaDiUnitàTerritorialeSovracomunale": null,
            "FlagComuneCapoluogoDiProvincia_CittàMetropolitana_libero": 1,
            "SiglaAutomobilistica": "MI",
            "CodiceComuneformatoNumerico": 15146,
            "CodiceComuneNumerico_2010_2016": 15146,
            "CodiceComuneNumerico_2006_2009": 15146,
            "CodiceComuneNumerico_1995_2005": 15146,
            "CodiceCatastaleDelComune": "F205",
            "CodiceElettorale": "1030491450",
            "CodiceBelfiore": "F205",
            "PrefissoTelefonico": "02",
            "CodiceCAP": "20121",
            "NUTS1_2010": "ITC",
            "NUTS2_2010": "ITC4",
            "NUTS3_2010": "ITC4C",
            "NUTS1_2021": "ITC",
            "NUTS2_2021": "ITC4",
            "NUTS3_2021": "ITC4C",
            "uuid": "40039d2f-6f2c-412d-ba46-185ba48bcff6",
            "updatedAt": "2024-11-07T00:06:17.000Z"
        }
    ]
}

Versione API

v1

la v1 è la prima versione della api molto grezza e semplice

Endpoint

https://comuni.alessiopellizzaro.it/api/v1/comuni

Parametri disponibili

Filtri

ogni parametri sotto puo essere passato in richiesta è verra utilizzato per effetuare un filtro di equivalenza nel db

CodiceRegione
CodicedellUnitaTerritorialeSovracomunale_Storico_1
ProgressivoDelComune
CodiceComuneFormatoAlfanumerico
Denominazione
DenominazioneIt
DenominazioneOther
CodiceRipartizioneGeografica
RipartizioneGeografica
Regione
DenominazioneDellUnitàTerritorialeSovracomunale
TipologiaDiUnitàTerritorialeSovracomunale
FlagComuneCapoluogoDiProvincia_CittàMetropolitana_libero
SiglaAutomobilistica
CodiceComuneformatoNumerico
CodiceComuneNumerico_2010_2016
CodiceComuneNumerico_2006_2009
CodiceComuneNumerico_1995_2005
CodiceCatastaleDelComune
CodiceElettorale
CodiceBelfiore
PrefissoTelefonico
CodiceCAP
NUTS1_2010
NUTS2_2010
NUTS3_2010
NUTS1_2021
NUTS2_2021
NUTS3_2021

in caso nell estrazione venga estratto un solo elemento apparirano nel oggeto dei valori aggiungivi corispondenti all'elenco delle strade registrate nel comune

Essempio

Richiesta

curl --location 'https://comuni.alessiopellizzaro.it/api/v1/comuni?Denominazione=Udine' \
--header 'Authorization: Bearer {{YOUR_TOKEN}}'

Risposta

{
    "success": true,
    "message": "Comuni ottenuti con successo.",
    "records": 1,
    "comuni": [
        {
            "CodiceRegione": 6,
            "CodicedellUnitaTerritorialeSovracomunale_Storico_1": null,
            "ProgressivoDelComune": 129,
            "CodiceComuneFormatoAlfanumerico": "030129",
            "Denominazione": "Udine",
            "DenominazioneIt": "Udine",
            "DenominazioneOther": null,
            "CodiceRipartizioneGeografica": "2",
            "RipartizioneGeografica": "Nord-est",
            "Regione": "Friuli-Venezia Giulia",
            "DenominazioneDellUnitàTerritorialeSovracomunale": null,
            "TipologiaDiUnitàTerritorialeSovracomunale": null,
            "FlagComuneCapoluogoDiProvincia_CittàMetropolitana_libero": 1,
            "SiglaAutomobilistica": "UD",
            "CodiceComuneformatoNumerico": 30129,
            "CodiceComuneNumerico_2010_2016": 30129,
            "CodiceComuneNumerico_2006_2009": 30129,
            "CodiceComuneNumerico_1995_2005": 30129,
            "CodiceCatastaleDelComune": "L483",
            "CodiceElettorale": "1060851290",
            "CodiceBelfiore": "L483",
            "PrefissoTelefonico": "0432",
            "CodiceCAP": "33100",
            "NUTS1_2010": "ITH",
            "NUTS2_2010": "ITH4",
            "NUTS3_2010": "ITH42",
            "NUTS1_2021": "ITH",
            "NUTS2_2021": "ITH4",
            "NUTS3_2021": "ITH42",
            "updatedAt": "2024-11-07T03:07:18.000Z",
            "streets": [
                "Autostazione di Udine",
                "Autostrada Alpe-Adria",
                "Via Ferdinando Urli",
                "Via Fermo Solari",
                "Via Fernando Franzolini",
                "Via Filippo Renati",
                "Via Fiore dei Liberi",
                "Via Fiume",
                "Via Flagogna",
                "Via Flaibano",
                "Via Flambro",
                "Via Floriano Candonio",
                "Via Forgaria",
                "Via Forni di Sotto",
                "Via Francesco Baracca",
                "Via Francesco Crispi",
                "Via Francesco De Gregori",
                "Via Francesco Dormisch",
                "Via Francesco Mantica",
                "Via Francesco Musoni",
                "Via Francesco Petrarca",
                "Via Francesco Tomadini",
                "Via Francesco Urbanis",
                "Via Francesco di Manzano",
                "Via Francesco di Toppo",
                "Via Friuli",
                "Via Fusine",
                "Via Gaeta",
                "..."
            ]
        }
    ]
}

v2 [Suggest]

la v2 è la versione avanzata delle Api con base di Ispirazione il protocollo ODataV4

Endpoint

https://comuni.alessiopellizzaro.it/api/v2/comuni

Ricerca

Filtri

$select : selezione dei campi da estrare in richiesta
$filter : filtri previsti in richiesta
$top : impostazione limite record da estarre
$orderby : ordiamento risultato
$format: formato risposta, valori disponibili:
- JSON [default]
- XML
- CSV
- TSV
- YAML

per altre info su query di estrazione vedere documentazione ODATA

Essempio di richiesta

curl --location 'http://localhost:3001/api/v2/comuni?$filter=Denominazione eq Milano' \
--header 'Authorization: Bearer {{ YOUR_TOKEN }}

Essempio di risposta

{
    "success": true,
    "message": "Comuni ottenuti con successo.",
    "records": 1,
    "comuni": [
        {
            "CodiceRegione": 3,
            "CodicedellUnitaTerritorialeSovracomunale_Storico_1": null,
            "ProgressivoDelComune": 146,
            "CodiceComuneFormatoAlfanumerico": "015146",
            "Denominazione": "Milano",
            "DenominazioneIt": "Milano",
            "DenominazioneOther": null,
            "CodiceRipartizioneGeografica": "1",
            "RipartizioneGeografica": "Nord-ovest",
            "Regione": "Lombardia",
            "DenominazioneDellUnitàTerritorialeSovracomunale": null,
            "TipologiaDiUnitàTerritorialeSovracomunale": null,
            "FlagComuneCapoluogoDiProvincia_CittàMetropolitana_libero": 1,
            "SiglaAutomobilistica": "MI",
            "CodiceComuneformatoNumerico": 15146,
            "CodiceComuneNumerico_2010_2016": 15146,
            "CodiceComuneNumerico_2006_2009": 15146,
            "CodiceComuneNumerico_1995_2005": 15146,
            "CodiceCatastaleDelComune": "F205",
            "CodiceElettorale": "1030491450",
            "CodiceBelfiore": "F205",
            "PrefissoTelefonico": "02",
            "CodiceCAP": "20121",
            "NUTS1_2010": "ITC",
            "NUTS2_2010": "ITC4",
            "NUTS3_2010": "ITC4C",
            "NUTS1_2021": "ITC",
            "NUTS2_2021": "ITC4",
            "NUTS3_2021": "ITC4C",
            "uuid": "40039d2f-6f2c-412d-ba46-185ba48bcff6",
            "updatedAt": "2024-11-07T00:06:17.000Z"
        }
    ]
}

Dettaglio Singolo Comune

per ottere il dettaglio di un singolo comune viene messo a disposzione il seguente Endpoint, si puo specifare il rispettivo CodiceComuneFormatoAlfanumerico del comune del quale sia bisogno delle infomazioni

https://comuni.alessiopellizzaro.it/api/v2/comuni/:CodiceComuneFormatoAlfanumerico

essempio di url completo

// MILANO
https://comuni.alessiopellizzaro.it/api/v2/comuni/015146

formato risposta

viene messo a disposzione il segente parametro per richiedere formati specifici in risposta - $format: formato risposta, valori disponibili: - JSON [default] - XML - CSV - TSV - YAML

Elenco Strade Comune

per ottere il dettaglio l'elenco delle strade di un comune si puo utilizare il seguente endpoint per il comune selezionato

https://comuni.alessiopellizzaro.it/api/v2/comuni/:CodiceComuneFormatoAlfanumerico/streets

essempio di url completo

// MILANO
https://comuni.alessiopellizzaro.it/api/v2/comuni/015146/streets

formato risposta

viene messo a disposzione il segente parametro per richiedere formati specifici in risposta - $format: formato risposta, valori disponibili: - JSON [default] - XML - CSV - TSV - YAML

Essempio di richiesta

curl --location 'https://comuni.alessiopellizzaro.it/api/v2/comuni/015146/streets' \
--header 'Authorization: Bearer {{ YOUR_TOKEN }}

Essempio di risposta

{
    "success": true,
    "message": "Comuni ottenuti con successo.",
    "records": 4830,
    "comuni": [
        {
            "street": "A4 Raccordo R20  direz. Venezia"
        },
        {
            "street": "A4 Raccordo R20 direz. V.le Certosa"
        },
        {
            "street": "A4 Raccordo R20 direz. Venezia"
        },
        {
            "street": "via Madre Virginia Besozzi"
        },
        {
            "street": "via Pesaro via Oroboni"
        },
        {
            "street": "via Senigallia"
        },
        {
            "street": "via Villoresi"
        }
        ...
    ]
}

Coordinate Comune

per ottere il dettaglio delle coordinate di un comune si puo utilizare il seguente endpoint per il comune selezionato

https://comuni.alessiopellizzaro.it/api/v2/comuni/:CodiceComuneFormatoAlfanumerico/coordinate

essempio di url completo

// MILANO
https://comuni.alessiopellizzaro.it/api/v2/comuni/015146/coordinate

formato risposta

viene messo a disposzione il segente parametro per richiedere formati specifici in risposta - $format: formato risposta, valori disponibili: - JSON [default] - XML - CSV - TSV - YAML

Essempio di richiesta

curl --location 'https://comuni.alessiopellizzaro.it/api/v2/comuni/015146/coordinate' \
--header 'Authorization: Bearer {{ YOUR_TOKEN }}

Essempio di risposta

{
    "success": true,
    "message": "Coordinate ottenute con successo.",
    "records": 1,
    "coordinate": [
        {
            "CodiceComuneFormatoAlfanumerico": "015146",
            "denominazione": "Milano",
            "lat": 45.468503,
            "lng": 9.1824027
        }
    ]
}

Elenco Provincie (Comuni Capoluogo di Provincia)

per ottere elenco dei Comuni Capoluogo di Provincia si puo utilizare il seguente endpoint per il comune selezionato

https://comuni.alessiopellizzaro.it/api/v2/provincie

Filtri

$select : selezione dei campi da estrare in richiesta
$filter : filtri previsti in richiesta
$top : impostazione limite record da estarre
$orderby : ordiamento risultato

formato risposta

viene messo a disposzione il segente parametro per richiedere formati specifici in risposta - $format: formato risposta, valori disponibili: - JSON [default] - XML - CSV - TSV - YAML

Essempio di richiesta

curl --location 'https://comuni.alessiopellizzaro.it/api/v2/provincie' \
--header 'Authorization: Bearer {{ YOUR_TOKEN }}

Essempio di risposta

{
    "success": true,
    "message": "Provincie ottenuti con successo.",
    "records": 109,
    "provincie": [
        {
            "CodiceRegione": 1,
            "CodicedellUnitaTerritorialeSovracomunale_Storico_1": null,
            "ProgressivoDelComune": 272,
            "CodiceComuneFormatoAlfanumerico": "001272",
            "Denominazione": "Torino",
            "DenominazioneIt": "Torino",
            "DenominazioneOther": null,
            "CodiceRipartizioneGeografica": "1",
            "RipartizioneGeografica": "Nord-ovest",
            "Regione": "Piemonte",
            "DenominazioneDellUnitàTerritorialeSovracomunale": null,
            "TipologiaDiUnitàTerritorialeSovracomunale": null,
            "FlagComuneCapoluogoDiProvincia_CittàMetropolitana_libero": 1,
            "SiglaAutomobilistica": "TO",
            "CodiceComuneformatoNumerico": 1272,
            "CodiceComuneNumerico_2010_2016": 1272,
            "CodiceComuneNumerico_2006_2009": 1272,
            "CodiceComuneNumerico_1995_2005": 1272,
            "CodiceCatastaleDelComune": "L219",
            "CodiceElettorale": "1010812620",
            "CodiceBelfiore": "L219",
            "PrefissoTelefonico": "011",
            "CodiceCAP": "10121",
            "NUTS1_2010": "ITC",
            "NUTS2_2010": "ITC1",
            "NUTS3_2010": "ITC11",
            "NUTS1_2021": "ITC",
            "NUTS2_2021": "ITC1",
            "NUTS3_2021": "ITC11",
            "uuid": "a120b74f-f1a2-4056-8676-0991bcaf2582",
            "updatedAt": "2024-11-06T21:57:31.000Z"
        },
        ...
    ]
}

Supporto

per richieste di supporto scrivere

info@alessiopellizzaro.it