API Information

Version:v1.0.0
Region:US and Canada
Used for:Bulk address geocoding for large-scale workflows outside of interactive or real-time use cases.

Overview

The Batch Processor API allows you to geocode large datasets efficiently by uploading a CSV file and processing all address records in a single job. This method significantly reduces network latency compared to individual geocoding calls. Multiple files can be uploaded and processed concurrently. Each batch job is private, uniquely identified, and only accessible by the creating user. Jobs can be started, canceled, monitored for status (including ETA), and configured with custom field outputs.

Key Capabilities

  • Secure upload and download links for CSV files
  • Private job token for secure job tracking
  • Start or cancel jobs on demand
  • Support for large files (>5GB)
  • Flexible field-level output customization
  • Health check endpoint for API status
  • Real-time job status and estimated completion time

Scope

Functionality

  • CSV Upload
  • Automated Geocoding
  • Enriched Data Output

Use Cases

  • Large-Scale Data Enrichment
  • List Cleaning
  • Market Analysis

The Process Involves

  • Obtaining a secure, unique upload URL and job token
  • Uploading the CSV file tied to the job token
  • Starting the geocoding process
  • Monitoring the job using the job token
  • Retrieving a secure download link upon completion
  • Downloading the enriched CSV file

Additional Information