Changelog #

1.14.0 (2025-01-20) #

For Russia (RU) dictionary has been updated - used GAR 2025-01-07
For Russia (RU) improved coordinate accuracy for address objects
For the GET /version service, the need to transfer the Authorization token in the header has been removed

Added the ability to automatically renew the license key. To activate the functionality, add the ProlongationServer = "https://api.apidq.io/v1 parameter for the license section in the address-config.toml file.

Example address-config.toml

[main]
ListenAddr = "0.0.0.0" #  ip address where the address service will be available 
ListenPort = "8083" #  port where the address service will be available 
Debug = false
[logger]
Facility = "service-address"
[postgresql]
Address = "0.0.0.0" #  ip postgresql server
Port = "5432" #  port postgresql server
Dbname = "apidq" #  apidq database
User = "apidq"
Password = "apidq"
[license]
Key = "LICENSE_KEY"
ProlongationServer = "https://api.apidq.io/v1"

Requirements for versions of dictionaries

-	+	-	-	-
services_20241030	ru_20250116	kz_20230201	ua_20211012	by_20221025

1.13.1 (2025-01-06) #

For Russia (RU) improved coordinate accuracy for address objects
For Russia (RU) fixed clean address errors

Requirements for versions of dictionaries

-	+	-	-	-
services_20241030	ru_20241204	kz_20230201	ua_20211012	by_20221025

1.13.0 (2024-10-30) #

For Russia (RU) dictionary has been updated - used GAR 2024-10-01
For Russia (RU) improved coordinate accuracy for address objects
For Russia (RU) fixed clean address errors
Fixed an incorrect index error in some answers of the address hints service
Improved operation of the address hints service for Kazakhstan (KZ) and Belarus (BY)
Improved parsing quality of the house part of the address

Requirements for versions of dictionaries

+	+	-	-	-
services_20241030	ru_20241030	kz_20230201	ua_20211012	by_20221025

1.12.0 (2024-07-04) #

For Russia (RU) dictionary has been updated - used GAR 2024-06-28
For Russia (RU) improved coordinate accuracy for address objects
For Russia (RU) fixed clean address errors
Improved stability of services

Requirements for versions of dictionaries

-	+	-	-	-
services_20230306	ru_20240704	kz_20230201	ua_20211012	by_20221025

1.11.1 (2024-06-05) #

Improved parsing quality of the house part of the address
Improved stability of services

Requirements for versions of dictionaries

-	-	-	-	-
services_20230306	ru_20240405	kz_20230201	ua_20211012	by_20221025

1.11.0 (2024-04-05) #

For Russia (RU) dictionary has been updated - used GAR 2024-04-02
Added time zone output for /clean/address, suggest/address services
For Russia (RU) improved coordinate accuracy for address objects

Requirements for versions of dictionaries

-	+	-	-	-
services_20230306	ru_20240405	kz_20230201	ua_20211012	by_20221025

1.10.0 (2024-01-17) #

For Russia (RU) dictionary has been updated - used GAR 2024-01-05
Added output of municipalities for /clean/address, suggest/address services
For Russia (RU) fixed clean address errors
For Russia (RU) improved coordinate accuracy for address objects
Improved operation of the address hints service

Requirements for versions of dictionaries

-	+	-	-	-
services_20230306	ru_20240117	kz_20230201	ua_20211012	by_20221025

1.9.1 (2023-11-03) #

Added a new API method - house part of the address standardization

Requirements for versions of dictionaries

-	-	-	-	-
services_20230306	ru_20231012	kz_20230201	ua_20211012	by_20221025

1.9.0 (2023-10-12) #

For Russia (RU) dictionary has been updated - used GAR 2023-10-06
For Russia (RU) improved coordinate accuracy for address objects
For Russia (RU) fixed clean address errors

Requirements for versions of dictionaries

-	+	-	-	-
services_20230306	ru_20231012	kz_20230201	ua_20211012	by_20221025

1.8.1 (2023-09-14) #

The standardization of address objects has been improved to the level of microdistrict
For Russia (RU) fixed clean address errors
For Russia (RU) improved standardization of addresses written with abbreviations and typos

Requirements for versions of dictionaries

-	-	-	-	-
services_20230306	ru_20230710	kz_20230201	ua_20211012	by_20221025

1.8.0 (2023-07-10) #

For Russia (RU) dictionary has been updated - used GAR 2023-07-04
For Russia (RU) improved coordinate accuracy for address objects

Requirements for versions of dictionaries

-	+	-	-	-
services_20230306	ru_20230710	kz_20230201	ua_20211012	by_20221025

1.7.2 (2023-06-16) #

The standardization of address objects has been improved to the level of settlements
For Russia (RU) fixed address hints by postcode errors when using scopes
For Russia (RU) improved coordinate accuracy for address objects

Requirements for versions of dictionaries

-	-	-	-	-
services_20230306	ru_20230530	kz_20230201	ua_20211012	by_20221025

1.7.1 (2023-05-30) #

Fixed the display of addresses with HTML special characters
For Russia (RU) fixed clean address errors
For Russia (RU) improved coordinate accuracy for address objects
Standardized error output

Requirements for versions of dictionaries

-	+	-	-	-
services_20230306	ru_20230530	kz_20230201	ua_20211012	by_20221025

1.7.0 (2023-04-16) #

For Russia (RU) dictionary has been updated - used GAR 2023-04-07

Requirements for versions of dictionaries

-	+	-	-	-
services_20230306	ru_20230412	kz_20230201	ua_20211012	by_20221025

1.6.1 (2023-03-20) #

For Russia (RU), improved coordinate accuracy for address objects
Fixed bug with displaying address codes of buildings in Zelenograd
Optimized the work of the address suggestion service
Fixed standardization errors for Kazakhstan (KZ)

Requirements for versions of dictionaries

+	+	+	-	-
services_20230306	ru_20230316	kz_20230201	ua_20211012	by_20221025

1.6.0 (2023-01-20) #

For Russia (RU) dictionary has been updated - used GAR 2023-01-10
For Russia (RU) fixed clean address errors
For Russia (RU) improved coordinate accuracy for address objects

Requirements for versions of dictionaries

-	+	-	-	-
services_20220517	ru_20230113	kz_20221025	ua_20211012	by_20221025

1.5.3 (2022-12-09) #

For Russia (RU) fixed clean address errors

Requirements for versions of dictionaries

-	-	-	-	-
services_20220517	ru_20221005	kz_20221025	ua_20211012	by_20221025

1.5.2 (2022-11-25) #

For Russia (RU) fixed clean address errors

Requirements for versions of dictionaries

-	-	-	-	-
services_20220517	ru_20221005	kz_20221025	ua_20211012	by_20221025

1.5.1 (2022-11-03) #

For Kazakhstan (KZ) and Belarus (BY), fixed errors in determining the address by coordinates
For Russia (RU) fixed address hints errors when using scopes

Requirements for versions of dictionaries

-	-	+	-	+
services_20220517	ru_20221005	kz_20221025	ua_20211012	by_20221025

1.5.0 (2022-10-10) #

For Russia (RU), dictionary has been updated - used GAR 2022-09-30
For Kazakhstan (KZ), coordinates of 99% of houses are fill
For Kazakhstan (KZ) the city of Nur-Sultan is renamed to Astana
Improved standardization of addresses in Russia written in English
Added a new API method to get the installed software version

Requirements for versions of dictionaries

-	+	+	-	-
services_20220517	ru_20221005	kz_20221005	ua_20211012	by_20220311

1.4.5 (2022-09-08) #

Added the scope parameter for method of address hints
Fixed bugs in standardization of addresses method

Requirements for versions of dictionaries

-	-	-	-	-
services_20220517	ru_20220721.dump	kz_20220610	ua_20211012	by_20220311

To update the database, you need to add indexes

sudo su postgres
psql db_apidq -c "create index ix_ru_addresses_region_name on ru.addresses(lower(region_name),address_level);"
psql db_apidq -c "create index ix_ru_addresses_area_name on ru.addresses(lower(area_name),address_level);"
psql db_apidq -c "create index ix_ru_addresses_city_name on ru.addresses(lower(city_name),address_level);"
psql db_apidq -c "create index ix_ru_addresses_cityarea_name on ru.addresses(lower(cityarea_name),address_level);"
psql db_apidq -c "create index ix_ru_addresses_settlement_name on ru.addresses(lower(settlement_name),address_level);"
psql db_apidq -c "create index ix_ru_addresses_planstructure_name on ru.addresses(lower(planstructure_name),address_level);"
psql db_apidq -c "create index ix_ru_addresses_street_name on ru.addresses(lower(street_name),address_level);"
exit

1.4.4 (2022-07-22) #

For Russia (RU), dictionary has been updated - used GAR 2022-07-05
Fixed bugs in standardization of addresses method

Requirements for versions of dictionaries

-	+	-	-	-
services_20220517	ru_20220721.dump	kz_20220610	ua_20211012	by_20220311

1.4.3 (2022-07-07) #

Fixed bugs in standardization of addresses method

Requirements for versions of dictionaries

-	-	-	-	-
services_20220517	>=ru_20220517	kz_20220610	ua_20211012	by_20220311

1.4.2 (2022-06-14) #

Fixed bug in address hints for Kazakhstan
Fixed application launch error if not all countries are connected

Requirements for versions of dictionaries

-	-	+	-	-
services_20220517	ru_20220517	kz_20220610	ua_20211012	by_20220311

1.4.1 (2022-06-06) #

Fixed bugs in the method of suggesting by coordinates
Fixed bugs in the method of address hints

Requirements for versions of dictionaries

-	-	-	-	-
services_20220517	ru_20220517	kz_20210801	ua_20211012	by_20220311

1.4.0 (2022-05-17) #

For Russia (RU), dictionary has been updated - used GAR (2022-04-26)
For Belarus (BY), dictionary has been updated
Optimized address data standardization speed
Added a new method - getting an address by ID (FIAS, GAR, KLADR, GA)
Added a new method - getting an address by coordinates

The application will require you to specify a license key, you can request it at support@apidq.io

After getting the key, you need to specify it in address-config.toml - add the parameter Key = XXX for the license section

Example address-config.toml

[main]
ListenAddr = "0.0.0.0" #  ip address where the address service will be available 
ListenPort = "8083" #  port where the address service will be available 
Debug = false
[logger]
Facility = "service-address"
[postgresql]
Address = "0.0.0.0" #  ip postgresql server
Port = "5432" #  port postgresql server
Dbname = "apidq" #  apidq database
User = "apidq"
Password = "apidq"
[license]
Key = "1sy6hgXA699LPoatkt2jeu3VCtm1x1sy6hgXA699LPoahchbS9C9OshefuP_v-Ebtvg="

You need to install the postgis extension for PostgreSQL database before updating the directories.
sudo apt install postgis
sudo su postgres
psql db_apidq -c 'CREATE EXTENSION postgis;'
exit

Requirements for versions of dictionaries

+	+	-	-	+
services_20220517	ru_20220517	kz_20210801	ua_20211012	by_20220311

1.3.1 (2022-02-01) #

Improved parsing quality of the house part of the address
Minor fixes in the address hints method response format

Requirements for versions of dictionaries

+	-	-	-	-
services_20220131	ru_20220125	kz_20210801	ua_20211012	by_20220121

1.3.0 (2022-01-25) #

For Russia (RU) added KLADR and GAR codes
GAR dictionary (2021-09-22) is used as default dictionary for Russia (RU)
In the response of address methods added field addressFull
For Belarus (BY), dictionary has been updated
Added support for standardization of addresses that are written in transliteration

Requirements for versions of dictionaries

+	+	-	+	+
services_20220125	ru_20220125	kz_20210801	ua_20211012	by_20220121

1.2.0 (2021-09-22) #

Russia dictionary (RU) updated as of August 31, 2021
Added address hints in Russian language for Ukraine (UA) addresses
The phone standardization method automatically removes unnecessary characters inside the phone number
Improved parsing of the house part if there is a - sign in the house number
Improved detection of OSM codes for Ukraine (UA)
Changed gateway-config.toml

Edit gateway-config.toml and add parameter Enabled = true for section addressService

Example gateway-config.toml

[main]
ListenAddr = "0.0.0.0" #  ip address where service will be available 
ListenPort = "8080" #  port where service will be available 
ReadTimeout = 60000
WriteTimeout = 60000
Debug = false
[logger]
Facility = "service-gateway"
[addressService]
Enabled = true
EndpointAddr = "address" #  ip address or host  service from address-config.toml
EndpointPort = "8083" #  port service from address-config.toml

Requirements for versions of dictionaries ↕

+	+	-	+	-
services_20210920	ru_20210920	kz_20210801	ua_20210916	by_20210801

1.1.9 (2021-09-14) #

Internal code refactoring

Requirements for versions of dictionaries ↕

-	-	-	-	-
services_20210831	ru_20210801	kz_20210801	ua_20210801	by_20210801

1.1.8 (2021-08-31) #

APIDQ-201: added default value for count parameter = 10 for address hints
APIDQ-205: analysis of special characters ("/","","-") when comparing building with the dictionaries

Requirements for versions of dictionaries ↕

+	-	-	-	-
services_20210831	ru_20210801	kz_20210801	ua_20210801	by_20210801