Questions about the decommissioning of the Geoclient v1 REST API

[mlipper]

Background

We recently announced that the publicly available Geoclient v1 REST API will be officially decommissioned on October 1st, 2025. This "issue" provides brief instructions on how to submit questions on this topic.

Instructions

1. Navigate to the Issues section of the mlipper/geoclient GitHub repository. If you're reading this, then you're already here!
2. (Important) On the right side of the page, click the word "Labels" and select "v1 to v2" from the drop-down list of choices. Note that you may have to scroll down the list to see it.
3. In the upper right part of the page, click the green "New Issue" button.
4. Provide a brief summary of your question in the "Add a title" box.
5. (Optional) Fill in the "Add a description" section with details.

---

About the decommissioning of Geoclient v1

The Geoclient v1 REST API will be officially decommissioned on October 1st, 2025 as part of our ongoing efforts to streamline our systems and improve security.

As an alternative, we encourage you to use Geoclient v2 which is backwards-compatible with v1. Geoclient v2 has additional features, better performance and is more secure. Like v1, Geoclient v2 usage is free and credentials are available after sign-up on the NYC API Developers Portal website.

Key Details:

• Service: Geoclient v1
• Endpoint: https://api.nyc.gov/geo/geoclient/v1
• Deactivation Date: October 1st, 2025
• Impact: After this date, any requests to the Geoclient v1 API endpoint will fail.

Alternative Solution:

• Service: Geoclient v2
• Endpoint: https://api.nyc.gov/geoclient/v2
• Backwards compatible with the v1 API
• Usage is free after sign-up
• Important: the URL path for the Geoclient v2 service is different from v1. Be sure to configure your application(s) with the correct Geoclient v2 endpoint URL.

Next Steps:

• Transition your application(s) to Geoclient v2 before October 1st, 2025.
• Log into the NYC Developer Portal and subscribe to the Geoclient v2 service.
• Contact our support team if you have questions or need assistance with the transition.

Resources:

• Step-by-step instructions on how to create an account on the NYC Developers Portal and sign up for access to Geoclient v2.
• Using Geoclient v2 in the Cloud explains how to authenticate your service calls.
• Questions about migrating from Geoclient v1 to v2 are answered on Geoclient’s GitHub Issues page. Use the “v1 to v2” label on the issues you create.
• The geoclient-examples project which demonstrates calling Geoclient v2 in multiple languages.
• Visit the NYC API Developers Portal website for information on Geoclient and other official NYC APIs.

Thanks for your interest in Geoclient!

[imstilllearningok]

Hi! How come there's no neighborhood data?

[mlipper]

@imstilllearningok - which endpoint and what neighborhood data are you asking about?

[SteveScott]

Is Geoclient v2 open source on GitHub?

[mlipper]

Hi @SteveScott,

Yes it is. It is available for use per the Apache 2.0 License. Please see:

https://github.com/mlipper/geoclient