Documentation
Batches API
Use this page to plan a batch workflow, prepare your input, and find guidance on quoting, processing, and managing jobs.
When to use this API
Process CSV rows through the Addresses v2 geocoder, reverse geocoder, or MailPoint. Submit a job for quoting, review the cost, start processing, and download the results.
Start with the Batches Quickstart for a complete submit, quote, start, and download workflow.
| You want to… | Use |
|---|---|
| Submit an input file and configuration for quoting | Submit batch job |
| Find your jobs or inspect progress | List batch jobs or Get batch job status |
| Change a job's configuration | Update batch job |
| Begin or stop processing | Start batch job or Stop batch job |
| Remove jobs | Delete batch jobs |
Access: Use a Geoscape Hub application with Batches API access and access to the address products you will use. Starting a job requires sufficient credits for its quote.
Send its Consumer Key directly in the Authorization header. See Authentication for application and tester setup.
Responses
- Submission starts an asynchronous workflow. Poll the job status before taking the next action
- Actions depend on the job's status. A quoted job is not yet processing
- Download output using the links returned for a completed job. Do not attach your Consumer Key to signed download URLs
Further guidance
- Files and Mappings: configure CSV input, column mappings, and JSONPath output fields
- Managing Jobs: interpret statuses, review quotes, retrieve results, and stop or delete jobs
- Error Handling and Rate Limiting: handle failed requests and choose polling intervals
Versions
| Version | Reference |
|---|---|
| v1 | Endpoint reference |
Last modified on