Geocode Dataflow API
Note
Bing Maps Spatial Data Service Geocode Dataflow API retirement
Bing Maps Spatial Data Service Geocode Dataflow API is deprecated and will be retired. Free (Basic) account customers can continue to use Bing Maps Spatial Data Service Geocode Dataflow API until June 30th, 2025. Enterprise account customers can continue to use Bing Maps Spatial Data Service Geocode Dataflow API until June 30th, 2028. To avoid service disruptions, all implementations using Bing Maps Spatial Data Service Geocode Dataflow API will need to be updated to use Azure Maps Get Geocoding Batch or Azure Maps Get Reverse Geocoding Batch API by the retirement date that applies to your Bing Maps for Enterprise account type. Azure Maps Geocoding Batch API and Azure Maps Reverse Geocode Batch API will be updated to support a larger number of locations per batch soon. For detailed migration guidance, see Migrate Bing Maps Geocode Dataflow API.
Azure Maps is Microsoft's next-generation maps and geospatial services for developers. Azure Maps has many of the same features as Bing Maps for Enterprise, and more. To get started with Azure Maps, create a free Azure subscription and an Azure Maps account. For more information about azure Maps, see Azure Maps Documentation. For migration guidance, see Bing Maps Migration Overview.
Before using this API, make sure you are aware of the Geocode and Data Source Limits.
About data schema versions: There are two versions of the input and output data schema for this API. The latest data schema (version 2.0) provides additional geocoding information in the response, such as different points for routing and display and a rectangular area that bounds the location. If you are a new user, version 2.0 is recommended because it provides the greatest flexibility. Version 1.0 users can upgrade to version 2.0, but must be aware of the changes in the data schema including some name changes that were made to match the REST Services Locations API.
The Geocode Dataflow API uses REST URLS to geocode and reverse-geocode large sets of spatial data. To use this API, you must:
Format your location data using the Data Schema v2.0 or Data Schema v1.0 (for existing users). The spatial data you upload can be in XML format, or it can be provided as sets of values that use commas, tabs, or pipe (|) characters to separate the values.
Get Job Status and watch for the job to complete.
For an overview of this process, see Walkthrough.
To get a list of all geocode dataflow jobs and data source jobs submitted in the last 15 days, see Get Job List.
In this Section
| Resource | Description |
|---|---|
| Create Job | Describes how to create a job to geocode and reverse-geocode the data. |
| Get Job Status | Describes how to get the status of a geocode job. |
| Download Results | Describes how to download geocoded results. |
| Response Data | Describes the information returned in the HTTP responses. |
| Walkthrough | Provides a detailed overview of how to use the Geocode Dataflow using version 2.0 of the data schema. |
| Sample Code | Provides complete sample code that uses the Geocode Dataflow and version 1.0 of the data schema to geocode data. |
| Data Schema v1.0 | Describes the original (version 1.0) data schema for the input data and the geocoded results. |
| Data Schema v2.0 | Describes version 2.0 of the data schema for the input data and the geocoded results. |
| Sample Input and Output v1.0 | Shows examples of all types of accepted input formats for the original (version 1.0) of the data schema. This includes XML examples and examples of sets of values separated by pipe (|), comma, or tab characters |
| Sample Input and Output v2.0 | Shows examples of all types of accepted input formats for version 2.0 of the data schema. This includes XML examples and examples of sets of values separated by pipe (|), comma, or tab characters |