> ## 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 multiple locations with custom settings

> POST version of the forecast endpoint, allowing for more customization



## OpenAPI

````yaml api-reference/pinpoint/openapi.json post /forecast
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:
    post:
      tags:
        - forecast
      summary: Get weather forecast for multiple locations with custom settings
      description: POST version of the forecast endpoint, allowing for more customization
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForecastRequest'
        required: true
      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: {}
      deprecated: false
      security: []
components:
  schemas:
    ForecastRequest:
      type: object
      properties:
        parameters:
          type: array
          description: List of weather parameters to include
          items:
            type: string
        daily_parameters:
          type: array
          description: List of daily-only weather parameters to include
          items:
            type: string
        locations:
          type: array
          description: List of locations to get forecasts for
          items:
            type: object
            properties:
              id:
                type: string
                description: Location ID
              lat:
                type: number
                description: Latitude (if ID not provided)
              lng:
                type: number
                description: Longitude (if ID not provided)
        cache:
          type: boolean
          description: >-
            Whether to use the current cache if available (default: true).
            Setting cache=false will invalidate the cache and return fresh data.
          default: true
        start:
          type: string
          description: Start time for the forecast
          default: now
        interval:
          type: integer
          description: Forecast interval in hours
          default: 24
        daily:
          type: boolean
          description: Whether to include daily forecast overview
          default: true
        segments:
          type: string
          description: Segmented overview mode
          enum:
            - 'true'
            - 'false'
            - day
            - 3hrs
            - 6hrs
          default: 'false'
        hourly:
          type: boolean
          description: Whether to include hourly forecasts
          default: true
        overrides:
          type: boolean
          description: Whether to apply overrides to the forecast data
          default: true
        nowcast:
          type: boolean
          description: Whether to include nowcast data
          default: false
        step:
          type: integer
          description: Time step in hours
          default: 1
        timezone:
          type: string
          description: Timezone to use for the forecast
        model:
          type: string
          description: Weather model to use
          default: default
        hijri:
          type: boolean
          description: Whether to include Hijri date information
          default: false
        info:
          type: boolean
          description: Whether to include location information
          default: false
    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

````