{"id":24060051,"url":"https://github.com/antoninobonanno/api-comuni-italiani","last_synced_at":"2026-04-14T03:31:01.052Z","repository":{"id":42230714,"uuid":"425587215","full_name":"AntoninoBonanno/api-comuni-italiani","owner":"AntoninoBonanno","description":"Unofficial API service, which returns information on Italian areas, regions, provinces and cities. (Source of data: ISTAT - Automatic database update)","archived":false,"fork":false,"pushed_at":"2024-10-10T04:20:25.000Z","size":953,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-26T13:47:19.045Z","etag":null,"topics":["api-rest","comuni-italiani","docker","express","nodejs","nodejs-server-api","prisma","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AntoninoBonanno.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"antoninobonanno"}},"created_at":"2021-11-07T18:43:51.000Z","updated_at":"2024-09-16T08:57:11.000Z","dependencies_parsed_at":"2025-02-26T13:43:29.248Z","dependency_job_id":"1d94bfc8-8686-4b6f-ae1b-f3ae51bf3db8","html_url":"https://github.com/AntoninoBonanno/api-comuni-italiani","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/AntoninoBonanno/api-comuni-italiani","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AntoninoBonanno%2Fapi-comuni-italiani","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AntoninoBonanno%2Fapi-comuni-italiani/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AntoninoBonanno%2Fapi-comuni-italiani/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AntoninoBonanno%2Fapi-comuni-italiani/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AntoninoBonanno","download_url":"https://codeload.github.com/AntoninoBonanno/api-comuni-italiani/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AntoninoBonanno%2Fapi-comuni-italiani/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31781292,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T02:24:21.117Z","status":"ssl_error","status_checked_at":"2026-04-14T02:24:20.627Z","response_time":153,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","comuni-italiani","docker","express","nodejs","nodejs-server-api","prisma","typescript"],"created_at":"2025-01-09T06:38:57.595Z","updated_at":"2026-04-14T03:31:01.040Z","avatar_url":"https://github.com/AntoninoBonanno.png","language":"TypeScript","funding_links":["https://ko-fi.com/antoninobonanno","https://ko-fi.com/C0C46QJ0M"],"categories":[],"sub_categories":[],"readme":"# API Comuni italiani\n\n[![Test](https://github.com/AntoninoBonanno/api-comuni-italiani/actions/workflows/docker-hub.yml/badge.svg)](https://github.com/AntoninoBonanno/api-comuni-italiani/actions/workflows/docker-hub.yml)\n[![Test](https://github.com/AntoninoBonanno/api-comuni-italiani/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/AntoninoBonanno/api-comuni-italiani/actions/workflows/codeql-analysis.yml)\n\n[![GitHub release](https://img.shields.io/github/v/release/AntoninoBonanno/api-comuni-italiani)](https://github.com/AntoninoBonanno/api-comuni-italiani/releases)\n[![Docker Image Size(latest by date)](https://img.shields.io/docker/image-size/antoninobonanno/api-comuni-italiani)](https://hub.docker.com/r/antoninobonanno/api-comuni-italiani \"Click to view the image on Docker Hub\")\n[![Docker stars](https://img.shields.io/docker/stars/antoninobonanno/api-comuni-italiani.svg)](https://hub.docker.com/r/antoninobonanno/api-comuni-italiani 'DockerHub')\n[![Docker pulls](https://img.shields.io/docker/pulls/antoninobonanno/api-comuni-italiani.svg)](https://hub.docker.com/r/antoninobonanno/api-comuni-italiani 'DockerHub')\n\n\n\nUnofficial API service, which returns information on Italian **areas**, **regions**, **provinces** and **cities**.\n\nService realized with Node.js server based on the Express framework and on the MySQL database.\n\n- Source of data: [ISTAT](https://www.istat.it/it/archivio/6789)\n- Project structure based\n  on [Express Startup Project](https://github.com/AntoninoBonanno/express-startup-project#express-startup-project)\n\n### Features\n\n- Automatic database update (The [ISTAT Permalink](https://www.istat.it/storage/codici-unita-amministrative/Elenco-comuni-italiani.xls) is checked\n  every 5 months - configurable)\n- API divided by [**areas**](/docs/api.md#areas), [**regions**](/docs/api.md#regions), [**provinces**](/docs/api.md#provinces) and [**cities**](/docs/api.md#cities) with the possibility of filtering the data. (See [documentation](/docs/api.md))\n\n## Startup instructions \n\n### From Docker (production)\n\nStarting an \"API Comuni italiani\" instance is simple:\n\n```\ndocker run -p 8000:8000 -e DATABASE_URL=\"mysql://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_DATABASE}\" --name api-comuni-italiani -d antoninobonanno/api-comuni-italiani:latest\n```\n\nExample: `DATABASE_URL=mysql://root:@host.docker.internal:3306/comuni-italiani`\n\nNOTE: use `host.docker.internal` instead of `localhost` as `DB_HOST` if you have a local database (not in a docker container)\n\n#### use docker-compose\n\nYou can see the example present in [docker/docker-compose.yml](docker/docker-compose.yml) and run the command:\n\n```\ndocker-compose -f docker/docker-compose.yml -p api-comuni-italiani up -d\n```\n\n**Environment Variables**\n\n| Parameter | Type | Description |\n| :--- | :--- | :--- |\n| `DATABASE_URL` | `connection string` | **Required**. The database connection string: `mysql://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_DATABASE}` |\n| `APP_NAME` | `string` | **Optional**. The name of app: default `API Comuni Italiani` |\n| `APP_ENV` | `development, production` | **Optional**. The environment mode: default `production` |\n| `APP_PORT` | `integer` | **Optional**. The local (internal) port where the server is exposed: default `8000` |\n| `ISTAT_SCAN_MONTHLY_PERIOD` | `integer` | **Optional**. How many months you want to scan on the ISTAT site, started every first day of month at 10:00: default `5` |\n\n### From Clone (development)\n\n0. Clone the repository\n1. Copy and rename `.env.example` file to `.env` and edit settings\n2. Run `npm install` command to install dependencies\n3. Run `npx prisma migrate dev` command to initialize the database or `npx prisma generate` command if the database\n   already exists\n4. Run `npm start` or `npm run dev` command to run local server (it restarts each time the code is changed)\n\n## Support me\n\n[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/C0C46QJ0M)\n\n## Getting Involved\n\nWant to help out? Found a bug? Missing a feature? Post an issue on\nour [issue tracker](https://github.com/AntoninoBonanno/api-comuni-italiani/issues).\n\nI welcome contributions no matter how small or big!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantoninobonanno%2Fapi-comuni-italiani","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fantoninobonanno%2Fapi-comuni-italiani","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantoninobonanno%2Fapi-comuni-italiani/lists"}