> For the complete documentation index, see [llms.txt](https://fatos-doc.fatos.biz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://fatos-doc.fatos.biz/fatos-api/search/address.md).

# Address

{% hint style="info" %}
See the [**API Key Issuance page**](/get-your-api-key.md) for information on using keys.
{% endhint %}

| Method | Request URI                          | Response Type |
| ------ | ------------------------------------ | ------------- |
| GET    | https\:/api.fatos.biz/search/v1/addr | JSON          |

### Parameter

<table><thead><tr><th width="200">Parameter</th><th>Required</th><th>Description</th><th>Sample</th></tr></thead><tbody><tr><td>key</td><td>Y</td><td>Your API Key.</td><td>key=xxxxxxxxxxx</td></tr><tr><td>kwd</td><td>Y</td><td>Name search: search word</td><td>kwd=서울 중구 한강대로 405</td></tr><tr><td>cx</td><td>Y</td><td>User's current location X coordinate (wgs84) (Longitude)</td><td>cx=126.896038</td></tr><tr><td>cy</td><td>Y</td><td>User's current location Y coordinate (wgs84) (Latitude)</td><td>cy=37.482901</td></tr><tr><td>sx</td><td>N</td><td>Search Criteria Location X Coordinates (WGS84)</td><td>sx=126.896038</td></tr><tr><td>sy</td><td>N</td><td>Search Criteria Location Y Coordinates (WGS84)</td><td>sy=37.482901</td></tr><tr><td>lang</td><td>Y</td><td>Search Language<br>Default : en</td><td>한국어: kr, 영어: en, 태국어: th …</td></tr><tr><td>pno</td><td>N</td><td>Page number<br>Default : 1</td><td>pno=1</td></tr><tr><td>cpp</td><td>N</td><td>Number of searches per page <br>Default : 20</td><td>cpp=20</td></tr></tbody></table>

### Response

|    NAME    |    Type    |                           Description                          |
| :--------: | :--------: | :------------------------------------------------------------: |
|     err    |   string   |      If there is an error, write the contents of the error     |
|    stype   |     int    |      The type of search used for the search. Internal Use      |
|    sort    |     int    |         The sort type used in the search. Internal Use         |
|     pno    |     int    |                           Page number                          |
|     cpp    |     int    |                   Number of searches per page                  |
|    total   |     int    |                       Number of searches                       |
|    items   |    Array   |                           Search list                          |
|     id     |   string   |                            Search ID                           |
|     flg    |     int    |                   Type of data. Internal Use                   |
|     pid    |   string   |                 Parent ID – Not currently used.                |
|     src    |     int    |                           Source Type                          |
|    cate    |   string   |             Large classification code. Internal Use            |
|    dist    | int(meter) |                            Distance                            |
|    entx    |   double   |                Entry point X coordinates (WGs84)               |
|    enty    |   double   |                Entry point Y coordinates (WGs84)               |
|    name    |   string   |                         Expression name                        |
|    posx    |   double   |                  Center X coordinates (WGs84)                  |
|    posy    |   double   |                  Center Y coordinates (WGs84)                  |
|    addr1   |   string   |                             Address                            |
|    addr2   |   string   |                 In Korea, the road name address                |
|    cate2   |   string   |              Division code. – Not currently used.              |
|    phone   |   string   |                Phone number: delimiter comma (,)               |
|    props   |    array   |              POI Properties – Not currently used.              |
|   hassub   |     int    | Sub POI Existence (0: None, Other : Yes) – Not currently used. |
|   s\_dist  | int(meter) |                         Screen Distance                        |
|  addr\_en  |   string   |                       an English address                       |
|   entries  |    array   |        Multiple Entry Points List – Not currently used.        |
|  name\_en  |   string   |                         an English name                        |
| geom\_type |   string   |                          geometry type                         |

### Response Sample

```javascript
{
    "err": null,
    "stype": 2,
    "sort": 0,
    "pgno": 1,
    "cnt": 20,
    "src_type": null,
    "data_type": 0,
    "items": [
        {
            "id": "738749103",
            "name": "서울 중구 봉래동2가 122",
            "name_en": null,
            "addr1": null,
            "addr2": "서울 중구 한강대로 405",
            "cate": null,
            "cate2": null,
            "geom": "POINT(126.970537262872 37.5556743315695)",
            "posx": 126.9705372628718,
            "posy": 37.555674331569534,
            "entx": 126.96998178200411,
            "enty": 37.55495218726866,
            "hassub": 0,
            "phone": null,
            "pid": null,
            "entries": null,
            "props": null,
            "dist": 10435,
            "wgpt": 1.0534160137176514,
            "src": 8,
            "flg": 3
        },
        ...
    ]
}
```