Skip to content

Latest commit

 

History

History
358 lines (186 loc) · 18.3 KB

CHANGES.md

File metadata and controls

358 lines (186 loc) · 18.3 KB

Changes to OpenCage Geocoding API.

  • 20241022

    We now set the field shipping_forecast_sea_area in the components portion of relevant geocoding results. Blog post.

  • 20240619

    We now additionally attempt to set the field toll_details in the roadinfo annotation if roadinfo=1 was set in the API request. Relevent section of the docs, Blog post.

  • 20240618

    Geocoding results in France now also contain the component local_authority, the value of which is the name of that location's EPCI. Blog post.

  • 20240509

    We now also provide the NUTS annotation for EU candidate countries (AL, ME, MK, RS, TR). Blog post.

  • 20240423

    One of the primary geocoders we aggregate behind our API is Nominatim. We made the switch to a newer version - Nominatim 4.4.0 - which introduces significant changes. While we have extensive tests it is difficult to foresee every possible permutation. Please let us know if you are seeing anything unexpected. Blog post.

  • 20240209

    We now additionally attempt to set the fields maxheight, maxweight, and maxwidth in the roadinfo annotation if roadinfo=1 was set in the API request. Relevent section of the docs, Blog post.

  • 20240202

    We have improved and upgraded (v3.1.2) our OpenAPI specification. Blog post.

  • 20240201

    We now attempt to set the field _normalized_city in the components section of geocoding results. Blog post.

  • 20240130

    We now also provide the NUTS annotation for EFTA countries (CH, IS, LI, NO). Blog post.

  • 20240129

    Reverse geocoding results now include the field distance_from_q which is the distance (in meters) from the coordinates in the q (query) parameter and the result. Details and example on the blog.

  • 20230801

    As recently announced the stay_informed section of our API response has now changed, we no longer provide a reference to Twitter.

  • 20230724

    From 1 August 2023 we will adapt the stay_informed portion of our API response to no longer include a reference to our Twitter account. Details on the blog.

  • 20230323

    We now support searching for UN/LOCODE codes, and, for paying customers, provide UN/LOCODE information as a new annotation. See the detailed documentation (includign caveats), blog post.

  • 20230209

    From 1 March 2023 the price and size of some of our geocoding subscription plans will change for new customers. Existing customers that are impacted by these changes will be contacted by email. Blog post explaining the details.

  • 20230113

    We have added a new annotation NUTS. See the annotation documentation, blog post.

  • 20230110

    Detailed blog post.

  • 20221219

    In January 2023 (target date 10 Jan 2023) we will adapt the stay_informed portion of our API response to include a reference to our Mastodon account. Details on the blog.

  • 20220701

    We have added a new annotation H3. See the annotation documentation, blog post.

  • 20220516

    If possible we now add a key ISO_3166-2to the components portion of each result. The value of the field is a list (not a single value) of ISO 3166-2 codes for that location. Detailed blog post with many examples, particularly of unexpected edge cases.

  • 20220321

    One of the primary geocoders we aggregate behind our API is Nominatim. Yesterday we made the switch to a newer version - Nominatim 4.0 - which introduces significant changes. While we have extensive tests it is difficult to foresee every possible permutation. Please let us know if you are seeing anything unexpected.

  • 20220215

    OpenCage Geosearch is now available. Detailed blog post

  • 20211016

    Legal headquarters of OpenCage GmbH has now moved to Hannover, Niedersachsen, Germany. Detailed blog post.

  • 20211001

    Sign up is now open for early access to our soon to be launched geosearch service. Detailed blog post.

  • 20210406

    Reverse geocoding requests that match roads with no names will now set "road": "unnamed road", in the components sections of results. Blog post with details.

  • 20200928

    One of the primary geocoders we aggregate behind our API is Nominatim. This morning (European time) we made the switch to a newer version - Nominatim 3.5 - which introduces significant changes to administrative hierarchies in some countries. While we have extensive tests it is difficult to foresee every possible permutation. Please let us know if you are seeing anything unexpected in the formatted or components sections of results.

  • 20200915

    • HTTPS requests with TLS < 1.2 are no longer supported. Invalid requests now return a 426 response. Blog post with details
    • map output format no longer supported

  • 20200831

    A reminder that on 15 Sept 2020 we will turn off support for HTTPS API requests using TLS 1.0 or 1.1. We have set up a server for testing for those who have not yet made the transition (details on our blog). Please make the switch to TLS 1.2+ as quickly as possible to ensure your service continues to work after the 15th of September.

  • 20200709

    In addition to our existing subscription pricing plans, we now also support one-time purchases.

  • 20200518

    Deprecation notice: from 15 September 2020

    • all API requests will need to be HTTPS TLS 1.2 or higher
    • we will no longer support the map output format

    Please see our blog post detailing these changes.

  • 20200414

    The OpenCage twitter account has changed to @OpenCage. We have accordingly changed the value in the stay_informed portion of the API response.

  • 20200413

    We now support requests using the HTTP/2 protocol. Blog post.

  • 20200403

    Paying customers can now, on a per API key basis, specify a value for the access-control-allow-origin HTTP header returned by the API as a way to limit domains on which AJAX requests can be made. Blog post with details.

  • 20200325

    Accounts can now be secured with two-factor authentication (2FA). Blog post.

  • 20200309

    Paying customers can now specify an allowed list of IP addresses that are able to query the geocoding API with a specific API key. Requests from all other addresses will receive a 403 - IP address rejected response. Blog post.

  • 20200120

    We now include a _category key and value in the componentsportion of each result. Documentation with link to a list of possible values. Blog post.

  • 20191223

    The OSM annotation now also contains a note_url key and value to make adding a note to OpenStreetMap easier. Blog post. Learn more about OpenStreetMap Notes.

  • 20191219

    more languages for our what3words annotation. The following languages are now supported: af,ar,bg,bn,cs,da,de,el,en,es,fi,fr,he,hu,id,it,ja,ko,mn,mr,ms,nl,no,pl,pt,ro,ru,sv,sw,ta,te,th,tr,xh,zh,zu

  • 20191211

    there is now an API key for use in testing and SDK development that will always generate a response with status 200 (as there had previously been for 402, 403, and 429. You can find the key the section of the API docs dealing with response codes.

  • 20191111

    there is now an API key for use in testing and SDK development that will always generate a response with status 429 (as there had previously been for 402 and 403. You can find the key the section of the API docs dealing with response codes.

  • 20191106

    previously requests with no query (q parameter) confusingly returned a 200response code. Such requests now return 400 response code with the message missing or bad query.

  • 20191002

    When possible we now also match terminated postcodes.

  • 20190715

    the OpenCage geocoding API is now operated by OpenCage GmbH. Blog post. The value of the thanks field of the API response has changed slightly, as explained in the blog post.

  • 20190709

    due to some architectural refactoring to handle increased usage, we have turned off the OSGB annotation. We hope to have it back soon.

  • 20190708

    if language=native has been specified we will attempt to return results in the local "official" language. See blog post for details, links to documentation and caveats.

  • 20190517

    we have added a new annotation UN_M49. See the annotation documentation, blog post

  • 20190430

    new optional parameter roadinfo, which tells the API to attempt to match roads and add information like speed limits. See documentation, blog post

  • 20190426

    we have added a new annotation roadinfo. See the annotation documentation.

  • 20190425

    We've changed the content of the licenses portion of our response format to point to our attribution page. See response format documentation

  • 20190423

    To aid in debugging we now return HTTP response code 401 in the case when either no API key is supplied in the request, or an invalid API key is supplied. Previously we had returned a 403 response in this situation. See details of all the various response codes the API can return.

  • 20190219

    when possible we now also return a continent key and value in the components portion of each result. See blog post.

  • 20190102

    map view upgraded to leaflet 1.4.0

  • 20190101

    we now have a couple of publicly available API keys for use in testing and SDK development that will always generate a response with status 402 and 403, respectively. You can find them in the section of the API docs dealing with response codes.

  • 20181219

    we now also return a ISO_3166-1_alpha-3 key and value in the components portion of each result. See blog post.

  • 20180923

    new version of the what3words library for our annotation means that we now support Afrikaans, Czech, Danish, Dutch, Greek, Japanese, Korean, Norwegian, Thai, Xhosa, and Zulu.

  • 20180902

    we have significantly improved the granularity and coverage of our timezone annotation.

  • 20180827

    previously results in geojson format had not returned some of the fields (examples include status, timestamp, and more) that other response formats had. This is now corrected, sorry for the oversight.

  • 20180801

    non-GET HTTP requests to the API now return 405 - Method not allowed error.

  • 20180727

    added FIPS annotation for locations in the United States. See docs.

  • 20180724

    New optional parameter proximity for biasing results is now supported. See docs.

  • 20180701

    From 1 August 2018 non-GET HTTP requests will be treated as errors. Please see our blog post for full details.

  • 20180619

    our website moved to https://opencagedata.com.

  • 20180618

    added the Australian G-NAF dataset as one of the backend geocoders we query.

  • 20180614

    if a result is a road (ie _type key in the components portion of the result has the value "road") if possible we now also return a road_type with values like those generally used in OpenStreetMap.

  • 20180403

    added the Addok geocoder as one of the backend geocoders we query.

  • 20180302

    new page to clarify GDPR/data protection

  • 20171203

    added flag annotation. See the full list of annotations.

  • 20171005

    In many parts of the world roads may have names but also numbers or some sort of unique identifier code. In cases where the result for a reverse geocoding query is such a road, the components portion of the response now also contains a road_reference key and value. In Europe some major highways may also have a national and European reference (for example "A 6" and "E 15"). In such cases we also set the road_reference_intl key and value.

  • 20170601

    the components portion of the result now contains the key ISO_3166-1_alpha-2 with the corresponding code for that location if we are able to determine it. This is in addition to the two-letter country_code which is also returned. This is mainly useful for places like Puerto Rico or Guadeloupe where the two codes differ.

  • 20170517

    We have launched a new account dashboard, removing the 3rd party dashboard from 3scale we had peviously used. Passwords in the old (and new) systems were encrypted, thus making it impossible for us to transfer them to the new system, so the first time you log into the new system you will have to create a new password. Sorry for the inconvenience.

  • 20170428

    new optional parameter abbrv. When supplied we attempt to shorten the formatted string that we return. Abbreviations are open-sourced in the address-formatting repo. See all optional parameters.

  • 20170415

    new version of the what3words library for our annotation means that we now support Arabic, Finnish, Italian, Mongolian, Polish, and Swedish

  • 20170311

    some tweaks to how we calculate confidence score for some of the backend geocoders, will generally result in slightly lower confidence

  • 20170111

    requests to geocode invalid coordinates now return a response with status code 400 Blog post.

  • 20161219

    added wikidata annotation.

  • 20161028

    added qibla annotation. Blog post.

  • 20161020

    added currency annotation. Blog post.

  • 20161007

    map view upgraded to leaflet 1.0.1

  • 20160914

    The optional parameter countrycode can be a comma seperated list of 2-letter country codes See full list of optional parameters.

  • 20160830

    Previously if a road name in the components field had been a digit it had been returned as a number not a string. This was unintentional and is now fixed. The road name is always returned as a string.

  • 20160601

    new optional request parameter no_record. See full list of optional parameters.

  • 20160503

    tweak to google-v3-json format to convert our types to google types

  • 20160423

    add _type key to the components list so that the type of object we geocoded to can more easily be determined. See docs.