> ## Documentation Index
> Fetch the complete documentation index at: https://docs-v2.ard.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get weather forecast for a location

> Replies with JSON object containing the hourly and daily forecasts for a single location specified by the 'id' parameter



## OpenAPI

````yaml api-reference/pinpoint/openapi.json get /forecast/{id}
openapi: 3.0.1
info:
  title: Pinpoint API
  description: >-
    Weather forecast API providing hourly and daily forecasts, location
    information, and weather parameters
  version: 1.0.0
servers:
  - url: http://pinpoint.devops.arabiaweather.com
    description: Development API server
  - url: http://n01.pinpoint.devops.arabiaweather.com
    description: Development node n01
  - url: http://n02.pinpoint.devops.arabiaweather.com
    description: Development node n02
  - url: http://n03.pinpoint.devops.arabiaweather.com
    description: Development node n03
  - url: http://n04.pinpoint.devops.arabiaweather.com
    description: Development node n04
  - url: http://n05.pinpoint.devops.arabiaweather.com
    description: Development node n05
  - url: http://internal-tools-pinpoint.devops.arabiaweather.com
    description: Internal tools API server
security: []
tags:
  - name: forecast
  - name: parameters
  - name: location
  - name: admin
  - name: debug
paths:
  /forecast/{id}:
    get:
      tags:
        - forecast
      summary: Get weather forecast for a location
      description: >-
        Replies with JSON object containing the hourly and daily forecasts for a
        single location specified by the 'id' parameter
      parameters:
        - name: id
          in: path
          description: Location ID or comma-separated list of location IDs
          required: true
          example: ''
          schema:
            type: string
        - name: start
          in: query
          description: >-
            Start time for the forecast (e.g., 'now', 'today', or ISO date
            string)
          required: false
          schema:
            type: string
            default: now
        - name: interval
          in: query
          description: Forecast interval in hours
          required: false
          schema:
            type: integer
            default: 24
        - name: parameters
          in: query
          description: >-
            Comma-separated list of weather parameters to include (e.g.,
            'surface.visibility,surface.temperature')
          required: false
          schema:
            type: string
        - name: hourly
          in: query
          description: Whether to include hourly forecasts
          required: false
          schema:
            type: boolean
            default: true
        - name: hijri
          in: query
          description: Whether to include Hijri date information
          required: false
          schema:
            type: boolean
            default: false
        - name: overrides
          in: query
          description: Whether to apply overrides to the forecast data
          required: false
          schema:
            type: boolean
            default: true
        - name: info
          in: query
          description: Whether to include location information
          required: false
          schema:
            type: boolean
            default: false
        - name: cache
          in: query
          description: >-
            Whether to use the current cache if available (default: true).
            Setting cache=false will invalidate the cache and return fresh data.
          required: false
          schema:
            type: boolean
            default: true
        - name: segments
          in: query
          description: Segmented overview mode ('true', 'false', 'day', '3hrs', '6hrs')
          required: false
          schema:
            type: string
            default: 'false'
            enum:
              - 'true'
              - 'false'
              - day
              - 3hrs
              - 6hrs
        - name: daily
          in: query
          description: Whether to include daily forecast overview
          required: false
          schema:
            type: boolean
            default: true
        - name: model
          in: query
          description: Weather model to use
          required: false
          schema:
            type: string
            default: default
        - name: timezone
          in: query
          description: >-
            Timezone to use for the forecast (if not specified, uses location's
            timezone)
          required: false
          schema:
            type: string
        - name: consumer_warning
          in: query
          description: Whether to include consumer warnings
          required: false
          schema:
            type: boolean
            default: false
        - name: status_details
          in: query
          description: Comma-separated list of status details to include
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Weather forecast data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForecastResponse'
          headers: {}
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: Location not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
      deprecated: false
      security: []
components:
  schemas:
    ForecastResponse:
      type: object
      properties:
        locations:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Location ID
              info:
                $ref: '#/components/schemas/LocationInfo'
                description: Location information (if requested)
              hourly:
                type: array
                description: Hourly forecast data
                items:
                  type: object
                  properties:
                    time:
                      type: integer
                      description: Forecast time in Unix timestamp or ISO format
                    period_of_day:
                      type: string
                      description: Period of day (morning, afternoon, evening, night)
                      enum:
                        - morning
                        - afternoon
                        - evening
                        - night
                    is_day:
                      type: boolean
                      description: Whether it's daytime at this hour
                    local_time:
                      type: string
                      format: date-time
                      description: Local time in ISO format with timezone
                    data:
                      type: object
                      description: Weather parameters data for this timestamp
                      additionalProperties:
                        type: number
                      properties: {}
              daily:
                type: array
                description: Daily forecast data
                items:
                  type: object
                  properties:
                    date:
                      type: string
                      format: date
                      description: Forecast date
                    day_time:
                      type: object
                      description: Daytime forecast data
                      properties: {}
                    night_time:
                      type: object
                      description: Nighttime forecast data
                      properties: {}
                    hijri:
                      type: object
                      description: Hijri date information (if requested)
                      properties: {}
              segments:
                type: array
                description: Segmented forecast data (if requested)
                items:
                  type: object
                  properties: {}
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
        statusCode:
          type: integer
          description: HTTP status code
        statusMessage:
          type: string
          description: HTTP status message
      example:
        error: Location not found
        statusCode: 404
        statusMessage: Not Found
    LocationInfo:
      type: object
      properties:
        name:
          type: object
          properties:
            en:
              type: string
              description: English location name
            ar:
              type: string
              description: Arabic location name
        lat:
          type: number
          description: Latitude
        lng:
          type: number
          description: Longitude
        timezone:
          type: string
          description: Location timezone
        elevation:
          type: number
          description: Elevation in meters
        countryCode:
          type: string
          description: Country code
        regionId:
          type: string
          description: Region ID

````