diff --git a/README.md b/README.md index 333b302..f84b7e0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# VAT-number-finder-API (Node.js) +# TAXID-VAT-number-finder-API (Node.js) This is a minimal Node.js + Express server that acts as an API wrapper around Finančná správa SR's open data interface. It allows you to look up Slovak companies by their IČO number (company identifier). @@ -43,6 +43,7 @@ http://localhost:3000/api/lookup?ico=36215589 ### Example response +TAX ID and VAT ID ```json { "source1_count": 1, @@ -77,6 +78,27 @@ http://localhost:3000/api/lookup?ico=36215589 } ``` +Only TAX ID +```json +{ + "source1_count": 1, + "source2_count": 0, + "merged_count": 1, + "data": [ + { + "id": 1245088, + "dic": "1023798534", + "ico": "17303885", + "nazov_ds": "Ľudmila Veľasová", + "obec": "Michalovce", + "psc": "07101", + "ulica_cislo": "Prof. Hlaváča 1887/14", + "nazov_statu": "Slovensko" + } + ] +} +``` + ## Requirements - Node.js 14 or newer