This repository was archived by the owner on Dec 16, 2025. It is now read-only.
feat(api): add Distance API for distance and duration calculations#4
Open
sylvesterdamgaard wants to merge 2 commits intomasterfrom
Open
feat(api): add Distance API for distance and duration calculations#4sylvesterdamgaard wants to merge 2 commits intomasterfrom
sylvesterdamgaard wants to merge 2 commits intomasterfrom
Conversation
Add 'straightline' as an alternative value for the distance calculation mode parameter across all distance-related endpoints and schemas. This provides a more intuitive name for great-circle distance calculations. Both 'haversine' and 'straightline' are now accepted and produce identical results (straight-line distance using the haversine formula).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a comprehensive Distance API to the Geocodio OpenAPI specification, enabling distance and duration calculations between coordinates with multiple modes of operation.
Changes
New Endpoints
/distance- Quick 1→1 or 1→N distance calculations via query parameters/distance- M×N matrix calculations and nearest-neighbor queries/distance/jobs- Async job creation for large matrix calculations (>10,000 elements)/distance/jobs- List distance calculation jobs/distance/jobs/{job_id}- Get job status and resultsEnhanced Existing Endpoints
/geocode- Addeddistance_*parameters for inline distance calculations/geocode- Extended batch request schemas to support per-row distance queries and matrix operationsNew Features
haversine(straight-line) anddriving(route-based with duration)milesorkmmax_results,max_distance,max_durationdistanceordurationNew Schema Components
GeocodingResultWithDistance- Geocoding result with inline distance dataDistanceQuery,DistanceTarget- Distance query structuresDistanceGetResponse,DistanceMatrixResponse,DistanceNearestResponse- Response schemasDistanceJobResponse,DistanceJobCompletedResponse- Async job schemasTest Plan
swagger-cli validate geocodio-api.ymlor similar tool$refpaths resolve correctly