AHOY Coverage API (1.0)

Download OpenAPI specification:Download

AMS Team: ams@theahoyapp.com

Coverage API

Authentication

apiKeyHeader

Security Scheme Type: API Key

Header parameter name: api-key

Calculate Coverage Area

endpoint for calculating the Coverage area

Authorizations:

apiKeyHeader

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"startLocation": {"lat": 25.039641,
"lng": 55.12464
},
"transportMode": "car",
"departureTime": 0,
"optimizeFor": "time",
"rangetype": "time",
"rangevalues": "300,600,1200"
}

Response samples

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"properties": {"type": "distance",
"value": 300,
"departureTime": "2022-02-21T09:14:45.0000000+00:00"
},
"geometry": {"type": "Polygon",
"coordinates": [[[55.122721,
25.039387
],
[55.122871,
25.039387
],
[55.123,
25.039344
],
[55.123086,
25.039258
],
[55.123172,
25.039258
],
[55.123258,
25.039344
],
[55.123386,
25.039387
],
[55.123558,
25.039387
],
[55.123687,
25.039344
],
[55.123773,
25.039258
],
[55.123901,
25.039215
],
[55.124073,
25.039215
],
[55.124202,
25.039258
],
[55.124288,
25.039515
],
[55.124459,
25.039687
],
[55.124545,
25.039687
],
[55.124588,
25.039558
],
[55.124588,
25.039387
],
[55.124545,
25.039258
],
[55.124459,
25.039172
],
[55.124416,
25.039043
],
[55.124416,
25.038357
],
[55.124373,
25.038228
],
[55.124116,
25.038142
],
[55.12403,
25.038056
],
[55.123944,
25.038056
],
[55.123858,
25.038142
],
[55.123601,
25.038228
],
[55.123429,
25.0384
],
[55.123429,
25.038486
],
[55.123558,
25.038528
],
[55.123687,
25.038486
],
[55.123773,
25.0384
],
[55.123901,
25.038357
],
[55.12403,
25.0384
],
[55.124202,
25.038571
],
[55.124245,
25.0387
],
[55.124245,
25.038872
],
[55.124202,
25.039001
],
[55.124073,
25.039043
],
[55.123386,
25.039043
],
[55.123258,
25.039001
],
[55.123172,
25.038915
],
[55.123043,
25.038872
],
[55.122871,
25.038872
],
[55.122743,
25.038915
],
[55.122571,
25.039086
],
[55.122528,
25.039215
],
[55.12255,
25.039344
],
[55.122614,
25.039387
],
[55.122721,
25.039387
]
]
]
}
}
]
}