AppyWay Traffic Data API

The AppyWay Traffic Data API provides real-time and historical traffic data for developers to integrate into their applications. This data includes information on traffic congestion, accidents, road closures, and other key events that can impact a driver's journey. By utilizing this API, developers can provide their users with up-to-date traffic information, optimize routes for more efficient travel, and enhance overall road safety.

OpenAPI Specification

appyway-traffic-data-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: AppyWay Traffic Data API
  version: '1.0'
  description: >-
    The AppyWay Traffic Data API provides real-time and historical traffic data
    for developers to integrate into their applications. This data includes
    information on traffic congestion, accidents, road closures, and other key
    events that can impact a driver's journey. By utilizing this API, developers
    can provide their users with up-to-date traffic information, optimize routes
    for more efficient travel, and enhance overall road safety. With AppyWay's
    Traffic Data API, users can enjoy a smoother and more seamless driving
    experience, ultimately saving time and reducing stress on the road.
servers:
  - url: https://api.appyway.com/v1/traffic-data
paths:
  /authorities/getAll:
    get:
      tags:
        - Authorities
      summary: >-
        AppyWay Gets the basic authority information for all authorities that you are entitled to access
      description: >-
        Gets the basic authority information for all authorities that you are
        entitled to access
      operationId: get-authorities-getall
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AuthorityListResult'
              examples:
                default:
                  value:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorityListResult'
              example:
                success: true
                data:
                  - id: string
                    name: string
                    regionId: string
                    countryId: string
                    authoritySlugs:
                      - string
                    ordnanceSurvey:
                      apiKey: string
                      license: string
                    hasFreeParkingOutsideZone: true
                    timeZoneId: string
                    privacyPolicyUrl: string
                    paymentProviderId: string
                    centroid:
                      latitude: 0
                      longitude: 0
                    boundingBox:
                      topLeft:
                        latitude: 0
                        longitude: 0
                      bottomRight:
                        latitude: 0
                        longitude: 0
                    fallbackZoneId: string
                    notes:
                      - noteVisibilityTypeId: 0
                        appliesToRestrictionTypeIds:
                          - 0
                        priority: 0
                        title: string
                        message: string
                        url: string
                        telephone: string
                    tags:
                      - string
                    authorityType: 0
                    legalName: string
                    capabilities:
                      allowIsPubliclyViewable: true
                      allowChargePointRequests: true
                      isVisibleOnPublicConsultation: true
                      enableSessionRecordingInternal: true
                      enableSessionRecordingPublic: true
                      inMaintenanceMode: true
                      enableAssets: true
                    capabilitiesState:
                      isStaticPubliclyViewable: true
                      isMovingPubliclyViewable: true
                      isOffStreetPubliclyViewable: true
                      acceptChargePointRequests: true
                      hideTariffsOnMapSchedules: true
                      hideTariffsOnStreets: true
                      hideRestrictedSpeedLimitsOnStreets: true
                    highwayAuthority: string
                    dataQuality: 1
                    lastTmoUpdate: string
                    reviewTerminalIds: true
            text/json:
              schema:
                $ref: '#/components/schemas/AuthorityListResult'
              example:
                success: true
                data:
                  - id: string
                    name: string
                    regionId: string
                    countryId: string
                    authoritySlugs:
                      - string
                    ordnanceSurvey:
                      apiKey: string
                      license: string
                    hasFreeParkingOutsideZone: true
                    timeZoneId: string
                    privacyPolicyUrl: string
                    paymentProviderId: string
                    centroid:
                      latitude: 0
                      longitude: 0
                    boundingBox:
                      topLeft:
                        latitude: 0
                        longitude: 0
                      bottomRight:
                        latitude: 0
                        longitude: 0
                    fallbackZoneId: string
                    notes:
                      - noteVisibilityTypeId: 0
                        appliesToRestrictionTypeIds:
                          - 0
                        priority: 0
                        title: string
                        message: string
                        url: string
                        telephone: string
                    tags:
                      - string
                    authorityType: 0
                    legalName: string
                    capabilities:
                      allowIsPubliclyViewable: true
                      allowChargePointRequests: true
                      isVisibleOnPublicConsultation: true
                      enableSessionRecordingInternal: true
                      enableSessionRecordingPublic: true
                      inMaintenanceMode: true
                      enableAssets: true
                    capabilitiesState:
                      isStaticPubliclyViewable: true
                      isMovingPubliclyViewable: true
                      isOffStreetPubliclyViewable: true
                      acceptChargePointRequests: true
                      hideTariffsOnMapSchedules: true
                      hideTariffsOnStreets: true
                      hideRestrictedSpeedLimitsOnStreets: true
                    highwayAuthority: string
                    dataQuality: 1
                    lastTmoUpdate: string
                    reviewTerminalIds: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /authorities/getFullBySlug:
    get:
      tags:
        - Authorities
      summary: AppyWay Get Full Authority By Slug
      description: >-
        Returns an object which has the location of the documents containing the
        full restrictions of an authority <br /> 
                    The documentation provided here shows the model you will find at these locations. The initial object contains only the URL's. <br />
                    You will have to fetch the documents from the returned authority URL's
      operationId: get-authorities-getfullbyslug
      parameters:
        - name: slug
          in: query
          description: >-
            The name of the authority. You can find this by making a request to
            the getAll endpoint
          schema:
            type: string
        - name: maxDate
          in: query
          description: >-
            Format - date-time (as date-time in RFC3339). The date at which you
            wish to view the restrictions
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AuthoritySnapshotInfoDocResult'
              examples:
                default:
                  value:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthoritySnapshotInfoDocResult'
              example:
                success: true
                data:
                  ospsUrl:
                    - type: string
                      features:
                        - type: string
                          id: string
                          geometry:
                            type: string
                            crs:
                              type: string
                              properties:
                                name: string
                          properties:
                            onStreetParkingId: string
                            zoneId: string
                            authorityId: string
                            address:
                              street: string
                              postcode: string
                              city: string
                              country: string
                            length: 0
                            bays: 0
                            restrictionTypeDetails:
                              - restrictionTypeId: 0
                                operatingHoursSets:
                                  - setGuid: string
                                    setId: string
                                    parkingEntitlementTypeIds:
                                      - 0
                                exceptionsSet:
                                  setGuid: string
                                  setId: string
                                locationNumber: string
                                terminalIds:
                                  - string
                                exemptionsSet:
                                  setGuid: string
                                  setId: string
                                tariffsSet:
                                  - setGuid: string
                                    setId: string
                                    parkingEntitlementTypeIds:
                                      - 0
                            notes:
                              - noteVisibilityTypeId: 0
                                appliesToRestrictionTypeIds:
                                  - 0
                                priority: 0
                                title: string
                                message: string
                                url: string
                                telephone: string
                            electricPoint:
                              manufacturer: string
                              manufacturerContactNumber: string
                              chargeFee: string
                              website: string
                              electricConnections:
                                - type: 0
                                  name: string
                                  description: string
                                  quantity: 0
                            venueId: string
                            sourceTag: string
                            sensorIds:
                              - string
                            centroid:
                              latitude: 0
                              longitude: 0
                            tags:
                              - string
                            linkedOspIds:
                              - string
                      properties: {}
                  zonesUrl:
                    type: string
                    features:
                      - type: string
                        id: string
                        geometry:
                          type: string
                          crs:
                            type: string
                            properties:
                              name: string
                          coordinates:
                            -   -   - 0
                        properties:
                          zoneId: string
                          authorityId: string
                          parentZoneId: string
                          type: 1
                          name: string
                          restrictionTypeDetails:
                            - restrictionTypeId: 0
                              operatingHoursSets:
                                - setGuid: string
                                  setId: string
                                  parkingEntitlementTypeIds:
                                    - 0
                              exceptionsSet:
                                setGuid: string
                                setId: string
                          notes:
                            - noteVisibilityTypeId: 0
                              appliesToRestrictionTypeIds:
                                - 0
                              priority: 0
                              title: string
                              message: string
                              url: string
                              telephone: string
                          venueId: string
                          sourceTag: string
                          tags:
                            - string
                    properties: {}
                  setsUrl:
                    operatingHoursSets:
                      - guid: string
                        setId: string
                        name: string
                        formattedName: string
                        operatingHours:
                          standardDays:
                            - ruleTime:
                                months:
                                  - 0
                                days:
                                  - 0
                                weekNumbers:
                                  - 0
                                hours:
                                  - start: '2024-10-11'
                                    end: '2024-10-11'
                                firstDate:
                                  month: 0
                                  day: 0
                                lastDate:
                                  month: 0
                                  day: 0
                              parkingEntitlementTypeIds:
                                - 0
                              maxStay: 0
                              minStay: 0
                              noReturn: 0
                              noReturnUntil: '2024-10-11'
                          eventDays:
                            - ruleTime:
                                months:
                                  - 0
                                days:
                                  - 0
                                weekNumbers:
                                  - 0
                                hours:
                                  - start: '2024-10-11'
                                    end: '2024-10-11'
                                firstDate:
                                  month: 0
                                  day: 0
                                lastDate:
                                  month: 0
                                  day: 0
                              parkingEntitlementTypeIds:
                                - 0
                              maxStay: 0
                              minStay: 0
                              noReturn: 0
                              noReturnUntil: '2024-10-11'
                    exemptionsSets:
                      - guid: string
                        setId: string
                        name: string
                        formattedName: string
                        exemptions:
                          - exemptionTypeId: 0
                            parkingEntitlementTypeId: 0
                            exemptionTimeTypeId: 0
                            exemptionApplies: true
                            maxStay: 0
                            noReturn: 0
                    exceptionsSets:
                      - guid: string
                        setId: string
                        name: string
                        formattedName: string
                        exceptions:
                          allHolidaysRestrictionExceptionTypeId: 0
                          allHolidaysOperatingHours:
                            standardDays:
                              - ruleTime:
                                  months:
                                    - 0
                                  days:
                                    - 0
                                  weekNumbers:
                                    - 0
                                  hours:
                                    - start: '2024-10-11'
                                      end: '2024-10-11'
                                  firstDate:
                                    month: 0
                                    day: 0
                                  lastDate:
                                    month: 0
                                    day: 0
                                parkingEntitlementTypeIds:
                                  - 0
                                maxStay: 0
                                minStay: 0
                                noReturn: 0
                                noReturnUntil: '2024-10-11'
                            eventDays:
                              - ruleTime:
                                  months:
                                    - 0
                                  days:
                                    - 0
                                  weekNumbers:
                                    - 0
                                  hours:
                                    - start: '2024-10-11'
                                      end: '2024-10-11'
                                  firstDate:
                                    month: 0
                                    day: 0
                                  lastDate:
                                    month: 0
                                    day: 0
                                parkingEntitlementTypeIds:
                                  - 0
                                maxStay: 0
                                minStay: 0
                                noReturn: 0
                                noReturnUntil: '2024-10-11'
                          daySpecificRestrictionExceptions:
                            - publicHolidayOrNamedDayId: string
                              restrictionExceptionTypeId: 0
                              operatingHours:
                                standardDays:
                                  - ruleTime:
                                      months:
                                        - 0
                                      days:
                                        - 0
                                      weekNumbers:
                                        - 0
                                      hours:
                                        - start: '2024-10-11'
                                          end: '2024-10-11'
                                      firstDate:
                                        month: 0
                                        day: 0
                                      lastDate:
                                        month: 0
                                        day: 0
                                    parkingEntitlementTypeIds:
                                      - 0
                                    maxStay: 0
                                    minStay: 0
                                    noReturn: 0
                                    noReturnUntil: '2024-10-11'
                                eventDays:
                                  - ruleTime:
                                      months:
                                        - 0
                                      days:
                                        - 0
                                      weekNumbers:
                                        - 0
                                      hours:
                                        - start: '2024-10-11'
                                          end: '2024-10-11'
                                      firstDate:
                                        month: 0
                                        day: 0
                                      lastDate:
                                        month: 0
                                        day: 0
                                    parkingEntitlementTypeIds:
                                      - 0
                                    maxStay: 0
                                    minStay: 0
                                    noReturn: 0
                                    noReturnUntil: '2024-10-11'
                    tariffSets:
                      - guid: string
                        setId: string
                        name: string
                        formattedName: string
                        tariffs:
                          - setName: string
                            parkingEntitlementTypeIds:
                              - 0
                            details:
                              - price: 0
                                surchargeDetail:
                                  surchargeType: 0
                                  surchargeTypeEnum: 0
                                  value: 0
                                  notes: string
                                  ruleType: 0
                                emissionsAdjustments:
                                  emissionsBandSetId: string
                                  adjustments:
                                    - emissionsBandId: string
                                      amount: 0
                                      surchargeDetail:
                                        surchargeType: 0
                                        surchargeTypeEnum: 0
                                        value: 0
                                        notes: string
                                        ruleType: 0
                                duration: 0
                                minimumPriceIncrement: 0
                                singlePaymentCanCrossMidnight: true
                                from: 0
                                upTo: 0
                            timeFrom: '2024-10-11'
                            timeTo: '2024-10-11'
                            firstDate:
                              month: 0
                              day: 0
                            lastDate:
                              month: 0
                              day: 0
                            months:
                              - 0
                            days:
                              - 0
                            timeType: 0
                    emissionsBandSets:
                      - guid: string
                        setId: string
                        name: string
                        formattedName: string
                        emissionsBands:
                          - id: string
                            name: string
                            emissions:
                              min: 0
                              max: 0
                            fuelTypes:
                              - 1
                            registrationYears:
                              min: 0
                              max: 0
                    isEmpty: true
                  mtfsUrl:
                    type: string
                    features:
                      - geoType: string
                        featureId: string
                        featureType: 0
                        authorityId: string
                        note: string
                        streetName: string
                        guid: string
                    properties: {}
            text/json:
              schema:
                $ref: '#/components/schemas/AuthoritySnapshotInfoDocResult'
              example:
                success: true
                data:
                  ospsUrl:
                    - type: string
                      features:
                        - type: string
                          id: string
                          geometry:
                            type: string
                            crs:
                              type: string
                              properties:
                                name: string
                          properties:
                            onStreetParkingId: string
                            zoneId: string
                            authorityId: string
                            address:
                              street: string
                              postcode: string
                              city: string
                              country: string
                            length: 0
                            bays: 0
                            restrictionTypeDetails:
                              - restrictionTypeId: 0
                                operatingHoursSets:
                                  - setGuid: string
                                    setId: string
                                    parkingEntitlementTypeIds:
                                      - 0
                                exceptionsSet:
                                  setGuid: string
                                  setId: string
                                locationNumber: string
                                terminalIds:
                                  - string
                                exemptionsSet:
                                  setGuid: string
                                  setId: string
                                tariffsSet:
                                  - setGuid: string
                                    setId: string
                                    parkingEntitlementTypeIds:
                                      - 0
                            notes:
                              - noteVisibilityTypeId: 0
                                appliesToRestrictionTypeIds:
                                  - 0
                                priority: 0
                                title: string
                                message: string
                                url: string
                                telephone: string
                            electricPoint:
                              manufacturer: string
                              manufacturerContactNumber: string
                              chargeFee: string
                              website: string
                              electricConnections:
                                - type: 0
                                  name: string
                                  description: string
                                  quantity: 0
                            venueId: string
                            sourceTag: string
                            sensorIds:
                              - string
                            centroid:
                              latitude: 0
                              longitude: 0
                            tags:
                              - string
                            linkedOspIds:
                              - string
                      properties: {}
                  zonesUrl:
                    type: string
                    features:
                      - type: string
                        id: string
                        geometry:
                          type: string
                          crs:
                            type: string
                            properties:
                              name: string
                          coordinates:
                            -   -   - 0
                        properties:
                          zoneId: string
                          authorityId: string
                          parentZoneId: string
                          type: 1
                          name: string
                          restrictionTypeDetails:
                            - restrictionTypeId: 0
                              operatingHoursSets:
                                - setGuid: string
                                  setId: string
                                  parkingEntitlementTypeIds:
                                    - 0
                              exceptionsSet:
                                setGuid: string
                                setId: string
                          notes:
                            - noteVisibilityTypeId: 0
                              appliesToRestrictionTypeIds:
                                - 0
                              priority: 0
                              title: string
                              message: string
                              url: string
                              telephone: string
                          venueId: string
                          sourceTag: string
                          tags:
                            - string
                    properties: {}
                  setsUrl:
                    operatingHoursSets:
                      - guid: string
                        setId: string
                        name: string
                        formattedName: string
                        operatingHours:
                          standardDays:
                            - ruleTime:
                                months:
                                  - 0
                                days:
                                  - 0
                                weekNumbers:
                                  - 0
                                hours:
                                  - start: '2024-10-11'
                                    end: '2024-10-11'
                                firstDate:
                                  month: 0
                                  day: 0
                                lastDate:
                                  month: 0
                                  day: 0
                              parkingEntitlementTypeIds:
                                - 0
                              maxStay: 0
                              minStay: 0
                              noReturn: 0
                              noReturnUntil: '2024-10-11'
                          eventDays:
                            - ruleTime:
                                months:
                                  - 0
                                days:
                                  - 0
                                weekNumbers:
                                  - 0
                                hours:
                                  - start: '2024-10-11'
                                    end: '2024-10-11'
                                firstDate:
                                  month: 0
                                  day: 0
                                lastDate:
                                  month: 0
                                  day: 0
                              parkingEntitlementTypeIds:
                                - 0
                              maxStay: 0
                              minStay: 0
                              noReturn: 0
                              noReturnUntil: '2024-10-11'
                    exemptionsSets:
                      - guid: string
                        setId: string
                        name: string
                        formattedName: string
                        exemptions:
                          - exemptionTypeId: 0
                            parkingEntitlementTypeId: 0
                            exemptionTimeTypeId: 0
                            exemptionApplies: true
                            maxStay: 0
                            noReturn: 0
                    exceptionsSets:
                      - guid: string
                        setId: string
                        name: string
                        formattedName: string
                        exceptions:
                          allHolidaysRestrictionExceptionTypeId: 0
                          allHolidaysOperatingHours:
                            standardDays:
                              - ruleTime:
                                  months:
 

# --- truncated at 32 KB (196 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/appyway/refs/heads/main/openapi/appyway-traffic-data-api-openapi.yml