Address search by ID #

Method address #

POST /idsearch/address

Functionality #

Allows you to get the exact address using the address register (FIAS, KLADR, etc.) and the value (ID) of the object.

Request parameters #

Parameter	Description	Type	Example
query	String to parse address	string	947ac692-01e0-4b3e-8bbe-82169a86fd95
type	The type of address registry to look up. Options: UNKNOWN, GAR, FIAS, KLADR, OSM, GA	string	FIAS
countryCode	Country code, using ISO 3166-1 alpha-2 string	string	RU

Sample request data #

{
  "query": "947ac692-01e0-4b3e-8bbe-82169a86fd95",
  "type": "FIAS",
  "countryCode": "RU"
}

Response options #

Parameter	Description
original	An incoming address string that participated in the standardization
address	Parsed and standardized address string
postcodeIn	ZIP code found in the input string
postcode	Postal code determined from the reference base in the process of standardization
region	Region, region. See the description of the addressLevel structure
area	District of the region. See the description of the addressLevel structure
city	Town. See the description of the addressLevel structure
cityArea	A district of the city. See the description of the addressLevel structure
settlement	Locality. See the description of the addressLevel structure
planStructure	Planning structure (microdistrict). See the description of the addressLevel structure
street	Street. See the description of the addressLevel structure
houseDetails	House part of the address. See the description of the structure houseDetails
coordinates	Geographical coordinates. See the description of the structure coordinates
country	Country. See the description of the country structure
valid	Sign of correctness of the address
quality	Address quality code. See Address Quality Code

Descriptions of structures are available on the address standardization page.

Sample response data #

{
  "original": "санкт-петербург козлова 30",
  "address": "г Санкт-Петербург, ул Козлова",
  "postcodeIn": "",
  "postcode": "198260",
  "region": {
    "fullName": "г Санкт-Петербург",
    "name": "Санкт-Петербург",
    "type": "г",
    "codes": {
      "fias": "c2deb16a-0330-4f05-821f-1d09c93331e6",
      "ga": "RU0780000000000000000000000",
      "osm": ""
    }
  },
  "area": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": ""
    }
  },
  "city": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": ""
    }
  },
  "cityArea": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": ""
    }
  },
  "settlement": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": ""
    }
  },
  "planStructure": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": ""
    }
  },
  "street": {
    "fullName": "ул Козлова",
    "name": "Козлова",
    "type": "ул",
    "codes": {
      "fias": "bcd993d5-11bb-49ba-957d-7f68ec1b3a70",
      "ga": "RU0780000000000000000000556",
      "osm": ""
    }
  },
  "houseDetails": {
    "fullName": "дом 30",
    "floor": "",
    "house": "30",
    "case": "",
    "build": "",
    "liter": "",
    "lend": "",
    "block": "",
    "pav": "",
    "flat": "",
    "office": "",
    "kab": "",
    "abon": "",
    "plot": "",
    "sek": "",
    "entr": "",
    "room": "",
    "hostel": "",
    "munit": ""
  },
  "coordinates": {
    "latitude": 59.8388,
    "longitude": 30.2184
  },
  "country": {
    "name": "Россия",
    "alpha2": "RU",
    "alpha3": "RUS",
    "numeric": 643
  },
  "valid": true,
  "quality": {
    "unique": 0,
    "actuality": 0,
    "undefined": 0,
    "level": 7,
    "house": 0,
    "geo": 7
  }
}