# Historical Vehicle Locations

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /openapi/vehicles/{id}/locations/:
    get:
      summary: Historical Vehicle Locations
      deprecated: false
      description: >-
        Returns all known vehicle locations during the given time range. This
        can be optionally filtered by specific vehicle IDs.
      operationId: vehicles_locations_list_2
      tags:
        - Vehicle Locations
        - Vehicle Locations
      parameters:
        - name: id
          in: path
          description: ''
          required: true
          example: ''
          schema:
            type: string
            format: uuid
        - name: page
          in: query
          description: A page number within the paginated result set.
          required: false
          schema:
            type: integer
        - name: page_size
          in: query
          description: Number of results to return per page.
          required: false
          schema:
            type: integer
        - name: startAt
          in: query
          description: '2024-05-22T01:40:16.274753Z'
          required: false
          schema:
            type: string
            format: date-time
        - name: endAt
          in: query
          description: '2024-05-22T01:40:16.274753Z'
          required: false
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedForVehicleLocationResponseList'
              examples:
                VehicleLocationsResponse:
                  summary: Vehicle Locations Response
                  value:
                    count: 10
                    page_size: 123
                    previous: null
                    current: 1
                    next: 2
                    results:
                      - - driver: 660e8400-e29b-41d4-a716-446655440001
                          vehicle: 770e8400-e29b-41d4-a716-446655440002
                          locatedAt: '2024-01-15T14:30:00.000Z'
                          location:
                            latitude: 37.7749
                            longitude: -122.4194
                          address: 1.5 miles from Austin, TX
                          heading: 180
                          speed: 65
                          odometer: 125000.5
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Vehicle Locations
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/586350/apis/api-8318762-run
components:
  schemas:
    PaginatedForVehicleLocationResponseList:
      type: object
      properties:
        count:
          type: integer
          examples:
            - 10
        page_size:
          type: integer
          examples:
            - 123
        previous:
          type: integer
          examples:
            - null
          nullable: true
        current:
          type: integer
          examples:
            - 1
        next:
          type: integer
          examples:
            - 2
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/ForVehicleLocationResponse'
      x-apidog-orders:
        - count
        - page_size
        - previous
        - current
        - next
        - results
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    ForVehicleLocationResponse:
      type: object
      properties:
        driver:
          type: string
          description: Driver UUID
          nullable: true
        vehicle:
          type: string
          description: Vehicle UUID
        locatedAt:
          type: string
          format: date-time
          description: Vehicle located at, date time
        location:
          allOf:
            - $ref: '#/components/schemas/Location'
          readOnly: true
        address:
          type: string
          description: Vehicle Address
        heading:
          type: number
          format: double
          description: Heading Vehicle 0 to 360
          nullable: true
        speed:
          type: number
          format: double
          description: Vehicle speed in kilometers per hour
        odometer:
          type: number
          format: double
          readOnly: true
          description: Vehicle odometer in kilometers
      required:
        - driver
        - vehicle
        - locatedAt
        - location
        - address
        - speed
        - odometer
      x-apidog-orders:
        - driver
        - vehicle
        - locatedAt
        - location
        - address
        - heading
        - speed
        - odometer
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Location:
      type: object
      properties:
        latitude:
          type: number
          format: double
          nullable: true
        longitude:
          type: number
          format: double
          nullable: true
      required:
        - latitude
        - longitude
      x-apidog-orders:
        - latitude
        - longitude
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://api.firsteld.com
    description: Prod Env
security: []

```