https://github.com/bartko-s/address

Slovak Republic Address API
https://github.com/bartko-s/address

address api slovak

Last synced: 5 days ago
JSON representation

Slovak Republic Address API

• Host: GitHub
• URL: https://github.com/bartko-s/address
• Owner: bartko-s
• Created: 2018-07-31T12:29:46.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-01-01T17:50:51.000Z (9 days ago)
• Last Synced: 2025-01-01T18:21:09.316Z (9 days ago)
• Topics: address, api, slovak
• Language: HTML
• Size: 4.65 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Slovak Address API

[![Latest Stable Version](https://poser.pugx.org/stefano/address/v/stable)](https://packagist.org/packages/stefano/address)

[![License](https://poser.pugx.org/stefano/address/license)](https://packagist.org/packages/stefano/address)

 

[![Donate on PayPal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://paypal.me/stevo4) 

 

[Online DEMO](https://address.stefanbartko.sk/)

## Installation

 - run `composer create-project stefano/address my-project`

 - create database `database.sql`

 - rename .end.dist to .env and fill it with your settings

 - run import `bin/console import:address`

## API Endpoints Documentation

### GET /api/address

- fields [array] [optional]

    - [string] street, city, postcode, post_office

- filters [array] [optional]

    - street [string] [optional]

    - city [string] [optional]

    - postcode [string] [optional]

    - post_office [string] [optional]        

- orders [array] [optional]

    - [string] street, city, postcode, post_office

- order-direction [asc or desc] [optional] default asc 

- limit [number] [optional] default 20 

- offset [number] [optional] default 0

 

Response:

```

{

    items: [

        street, string,

        city: string,

        postcode: string,

        post_office: string

    ]

}

```