The AppyWay Explorer API allows developers to access a wealth of data related to parking and electric vehicle charging infrastructure. With this API, developers can seamlessly integrate real-time information such as parking availability, pricing, and location details into their own applications. This allows for improved user experience and convenience for drivers seeking parking spaces or charging stations.
openapi: 3.0.1
info:
title: AppyWay Explorer API
version: '1.0'
description: >-
The AppyWay Explorer API allows developers to access a wealth of data
related to parking and electric vehicle charging infrastructure. With this
API, developers can seamlessly integrate real-time information such as
parking availability, pricing, and location details into their own
applications. This allows for improved user experience and convenience for
drivers seeking parking spaces or charging stations. Additionally, the API
offers insights into traffic conditions and traffic flow, providing valuable
information for urban planning and transportation management. Overall, the
AppyWay Explorer API streamlines the process of accessing and utilizing
parking and charging infrastructure data, ultimately improving efficiency
and accessibility in urban environments.
servers:
- url: https://api.appyway.com/v1/explorer
paths:
/fetchAuthorityById:
post:
tags:
- Authorities
summary: AppyWay Fetch an authority by ID
description: Returns a specific authority by its ID
operationId: post-fetchauthoritybyid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FetchAuthorityByIdQuery'
example:
id: string
text/json:
schema:
$ref: '#/components/schemas/FetchAuthorityByIdQuery'
example:
id: string
application/*+json:
schema:
$ref: '#/components/schemas/FetchAuthorityByIdQuery'
example:
id: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorityOkResponse'
example:
success: true
result:
entityId: string
name: string
eTag: string
notes:
- message: string
paymentProviders:
- id: string
name: string
cardPaymentsExternalUrl: string
paymentsTelephone: string
paymentsAppDeepLinks: {}
entityType: 1
countryId: string
geometry:
type: string
crs:
type: string
properties:
name: string
geometries:
- type: string
crs:
type: string
properties:
name: string
hasFreeParkingOutsideZone: true
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
example:
success: true
message: string
'429':
$ref: '#/components/responses/TooManyRequests'
/fetchEntitiesByIds:
post:
tags:
- Bulk
summary: AppyWay Fetches entities by their IDs
description: Retrieve a bulk list of entities of different types by their IDs
operationId: post-fetchentitiesbyids
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FetchEntitiesByIdsQuery'
example:
ids:
- string
geometryPreference:
basemap: 1
geometryTypes:
- 1
text/json:
schema:
$ref: '#/components/schemas/FetchEntitiesByIdsQuery'
example:
ids:
- string
geometryPreference:
basemap: 1
geometryTypes:
- 1
application/*+json:
schema:
$ref: '#/components/schemas/FetchEntitiesByIdsQuery'
example:
ids:
- string
geometryPreference:
basemap: 1
geometryTypes:
- 1
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/MapEntitiesResponseOkResponse'
example:
success: true
result:
parkingEntities:
- entityId: string
entityType: 1
name: string
eTag: string
address:
street: string
city: string
country: string
postcode: string
locationCode: string
totalCapacity: 0
zoneId: string
authorityId: string
features:
type: string
features:
- type: string
id: string
geometry:
type: string
crs:
type: string
properties:
name: string
geometries:
- type: string
crs:
type: string
properties:
name: string
properties:
basemap: 1
properties: {}
paymentMethodIds:
- 0
operator:
id: string
name: string
cardPaymentsExternalUrl: string
paymentsTelephone: string
paymentsAppDeepLinks: {}
telephone: string
website: string
onStreetParkingTypeIds:
- 1
facilityTypeIds:
- 0
venueId: string
zones:
- entityId: string
name: string
eTag: string
geometry:
type: string
crs:
type: string
properties:
name: string
geometries:
- type: string
crs:
type: string
properties:
name: string
notes:
- message: string
authorityId: string
zoneType: 1
venueId: string
entityType: 1
authorities:
- entityId: string
name: string
eTag: string
notes:
- message: string
paymentProviders:
- id: string
name: string
cardPaymentsExternalUrl: string
paymentsTelephone: string
paymentsAppDeepLinks: {}
entityType: 1
countryId: string
geometry:
type: string
crs:
type: string
properties:
name: string
geometries:
- type: string
crs:
type: string
properties:
name: string
hasFreeParkingOutsideZone: true
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
example:
success: true
message: string
errors:
- property: string
code: string
message: string
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/fetchEventDatesById:
post:
tags:
- Parking
summary: AppyWay Fetch event dates by id
description: Searches for event dates with the supplied entity ID.
operationId: post-fetcheventdatesbyid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FetchEventDatesByIdQuery'
example:
entityId: string
startDate: '2020-01-20'
endDate: '2020-01-20'
text/json:
schema:
$ref: '#/components/schemas/FetchEventDatesByIdQuery'
example:
entityId: string
startDate: '2020-01-20'
endDate: '2020-01-20'
application/*+json:
schema:
$ref: '#/components/schemas/FetchEventDatesByIdQuery'
example:
entityId: string
startDate: '2020-01-20'
endDate: '2020-01-20'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ParkingEntityEventDatesResultOkResponse'
example:
success: true
result:
entityId: string
entityType: 1
entityETag: string
timeZoneId: string
eventDates:
- '2020-01-20'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
example:
success: true
message: string
'429':
$ref: '#/components/responses/TooManyRequests'
/fetchOperatingHoursById:
post:
tags:
- Parking
summary: AppyWay Fetch operating hours by id
description: Searches for operating hours with the supplied entity ID.
operationId: post-fetchoperatinghoursbyid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FetchOperatingHoursByIdQuery'
example:
entityId: string
includeNotApplicableOperatingHours: true
dates:
- '2020-01-20'
includeClosedPeriods: true
includeApplicableOperatingHoursDetail: true
date: '2020-01-20'
vehicleOperatorContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
endDate: '2020-01-20'
startDate: '2020-01-20'
text/json:
schema:
$ref: '#/components/schemas/FetchOperatingHoursByIdQuery'
example:
entityId: string
includeNotApplicableOperatingHours: true
dates:
- '2020-01-20'
includeClosedPeriods: true
includeApplicableOperatingHoursDetail: true
date: '2020-01-20'
vehicleOperatorContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
endDate: '2020-01-20'
startDate: '2020-01-20'
application/*+json:
schema:
$ref: '#/components/schemas/FetchOperatingHoursByIdQuery'
example:
entityId: string
includeNotApplicableOperatingHours: true
dates:
- '2020-01-20'
includeClosedPeriods: true
includeApplicableOperatingHoursDetail: true
date: '2020-01-20'
vehicleOperatorContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
endDate: '2020-01-20'
startDate: '2020-01-20'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/ParkingEntityOperatingHoursResultOkResponse
example:
success: true
result:
entityId: string
entityType: 1
entityETag: string
timeZoneId: string
operatingHours:
- paymentMethodIds:
- 0
permittedContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
openPeriods:
- start: '2024-10-11'
end: '2024-10-11'
date: '2020-01-20'
status: 1
notApplicableOperatingHours:
- paymentMethodIds:
- 0
requirements:
vehicleTypeIds:
- 0
activityTypeIds:
- 0
fuelTypeIds:
- 0
permits:
- permitTypeId: 0
openPeriods:
- start: '2024-10-11'
end: '2024-10-11'
date: '2020-01-20'
status: 1
applicableOperatingHoursDetail:
- paymentMethodIds:
- 0
requirements:
vehicleTypeIds:
- 0
activityTypeIds:
- 0
fuelTypeIds:
- 0
permits:
- permitTypeId: 0
openPeriods:
- start: '2024-10-11'
end: '2024-10-11'
date: '2020-01-20'
status: 1
closedPeriods:
- start: '2020-01-20T00:00:00.0000000+00:00'
end: '2020-01-20T00:00:00.0000000+00:00'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
example:
success: true
message: string
'429':
$ref: '#/components/responses/TooManyRequests'
/fetchOperatingHoursByIds:
post:
tags:
- Parking
summary: AppyWay Fetch operating hours by ids
description: Searches for operating hours with the supplied entities IDs.
operationId: post-fetchoperatinghoursbyids
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FetchOperatingHoursByIdsQuery'
example:
ids:
- string
vehicleOperatorContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
date: '2020-01-20'
startDate: '2020-01-20'
endDate: '2020-01-20'
dates:
- '2020-01-20'
includeNotApplicableOperatingHours: true
includeApplicableOperatingHoursDetail: true
includeClosedPeriods: true
text/json:
schema:
$ref: '#/components/schemas/FetchOperatingHoursByIdsQuery'
example:
ids:
- string
vehicleOperatorContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
date: '2020-01-20'
startDate: '2020-01-20'
endDate: '2020-01-20'
dates:
- '2020-01-20'
includeNotApplicableOperatingHours: true
includeApplicableOperatingHoursDetail: true
includeClosedPeriods: true
application/*+json:
schema:
$ref: '#/components/schemas/FetchOperatingHoursByIdsQuery'
example:
ids:
- string
vehicleOperatorContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
date: '2020-01-20'
startDate: '2020-01-20'
endDate: '2020-01-20'
dates:
- '2020-01-20'
includeNotApplicableOperatingHours: true
includeApplicableOperatingHoursDetail: true
includeClosedPeriods: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/ParkingEntityOperatingHoursResultIReadOnlyCollectionOkResponse
example:
success: true
result:
- entityId: string
entityType: 1
entityETag: string
timeZoneId: string
operatingHours:
- paymentMethodIds:
- 0
permittedContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
openPeriods:
- start: '2024-10-11'
end: '2024-10-11'
date: '2020-01-20'
status: 1
notApplicableOperatingHours:
- paymentMethodIds:
- 0
requirements:
vehicleTypeIds:
- 0
activityTypeIds:
- 0
fuelTypeIds:
- 0
permits:
- permitTypeId: 0
openPeriods:
- start: '2024-10-11'
end: '2024-10-11'
date: '2020-01-20'
status: 1
applicableOperatingHoursDetail:
- paymentMethodIds:
- 0
requirements:
vehicleTypeIds:
- 0
activityTypeIds:
- 0
fuelTypeIds:
- 0
permits:
- permitTypeId: 0
openPeriods:
- start: '2024-10-11'
end: '2024-10-11'
date: '2020-01-20'
status: 1
closedPeriods:
- start: '2020-01-20T00:00:00.0000000+00:00'
end: '2020-01-20T00:00:00.0000000+00:00'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/fetchParkingEntityById:
post:
tags:
- Parking
summary: AppyWay Fetch a parking Entity by ID
description: Retrieves a parking entity by its ID
operationId: post-fetchparkingentitybyid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FetchParkingEntityByIdQuery'
example:
id: string
text/json:
schema:
$ref: '#/components/schemas/FetchParkingEntityByIdQuery'
example:
id: string
application/*+json:
schema:
$ref: '#/components/schemas/FetchParkingEntityByIdQuery'
example:
id: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ParkingEntityOkResponse'
example:
success: true
result:
entityId: string
entityType: 1
name: string
eTag: string
address:
street: string
city: string
country: string
postcode: string
locationCode: string
totalCapacity: 0
zoneId: string
authorityId: string
features:
type: string
features:
- type: string
id: string
geometry:
type: string
crs:
type: string
properties:
name: string
geometries:
- type: string
crs:
type: string
properties:
name: string
properties:
basemap: 1
properties: {}
paymentMethodIds:
- 0
operator:
id: string
name: string
cardPaymentsExternalUrl: string
paymentsTelephone: string
paymentsAppDeepLinks: {}
telephone: string
website: string
onStreetParkingTypeIds:
- 1
facilityTypeIds:
- 0
venueId: string
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
example:
success: true
message: string
'429':
$ref: '#/components/responses/TooManyRequests'
/fetchParkingQuoteById:
post:
tags:
- Parking
summary: AppyWay Fetch a parking quote by id
description: >-
Searches for a parking result with the supplied ID. Result indicates
whether parking is allowed at the location.
If parking is allowed for all or part of the requested window,
the result contains a list of quotes containing information such as
price, payment methods, maximum stay and no return policy.
operationId: post-fetchparkingquotebyid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FetchParkingQuoteByIdQuery'
example:
startTime: string
entityId: string
vehicleOperatorContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
duration: 3.17:25:30.5000000
endTime: string
text/json:
schema:
$ref: '#/components/schemas/FetchParkingQuoteByIdQuery'
example:
startTime: string
entityId: string
vehicleOperatorContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
duration: 3.17:25:30.5000000
endTime: string
application/*+json:
schema:
$ref: '#/components/schemas/FetchParkingQuoteByIdQuery'
example:
startTime: string
entityId: string
vehicleOperatorContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
duration: 3.17:25:30.5000000
endTime: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ParkingEntitySearchResultOkResponse'
example:
success: true
result:
entityId: string
entityType: 1
quotes:
- cost: 0
currency: string
minCost: 0
minStayUntil: string
canExtendUntil: string
pricedUntil: string
noReturnUntil: string
freeUntil: string
becomesFreeAt: string
isFreeParking: true
paymentMethodIds:
- 0
permittedContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
rulesApplyUntil: string
surcharge:
value: 0
valueType: 1
criteria:
vehicleOperatorContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
maxVehicleManufactureYear: 0
distance: 0
parkingAllowed: 1
entityETag: string
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
example:
success: true
message: string
'429':
$ref: '#/components/responses/TooManyRequests'
/fetchParkingQuotesByIds:
post:
tags:
- Parking
summary: AppyWay Fetch parking quotes by ids
description: >-
Searches for a parking result with the supplied IDs. Result indicates
whether parking is allowed at the location.
If parking is allowed for all or part of the requested window,
the result contains a list of quotes containing information such as
price, payment methods, maximum stay and no return policy.
operationId: post-fetchparkingquotesbyids
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FetchParkingQuotesByIdsQuery'
example:
startTime: string
duration: 3.17:25:30.5000000
vehicleOperatorContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
ids:
- string
endTime: string
text/json:
schema:
$ref: '#/components/schemas/FetchParkingQuotesByIdsQuery'
example:
startTime: string
duration: 3.17:25:30.5000000
vehicleOperatorContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
ids:
- string
endTime: string
application/*+json:
schema:
$ref: '#/components/schemas/FetchParkingQuotesByIdsQuery'
example:
startTime: string
duration: 3.17:25:30.5000000
vehicleOperatorContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
ids:
- string
endTime: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ParkingQuotesResponseOkResponse'
example:
success: true
result:
requestedStartTime: string
requestedDuration: 3.17:25:30.5000000
parking:
- entityId: string
entityType: 1
quotes:
- cost: 0
currency: string
minCost: 0
minStayUntil: string
canExtendUntil: string
pricedUntil: string
noReturnUntil: string
freeUntil: string
becomesFreeAt: string
isFreeParking: true
paymentMethodIds:
- 0
permittedContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
- permitTypeId: 0
rulesApplyUntil: string
surcharge:
value: 0
valueType: 1
criteria:
vehicleOperatorContext:
vehicleTypeId: 0
activityTypeId: 0
fuelTypeId: 0
permits:
# --- truncated at 32 KB (183 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/appyway/refs/heads/main/openapi/appyway-explorer-api-openapi.yml