> ## Documentation Index
> Fetch the complete documentation index at: https://kb.solargis.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the Time Series requestId

## OpenAPI

````json POST /ts/data-request
{
  "openapi": "3.0.3",
  "info": {
    "title": "Solargis API documentation",
    "version": "2.1.1",
    "description": "Explore Solargis API endpoints and learn how to retrieve TimeSeries, TMY, and other data from your Solargis subscriptions."
  },
  "servers": [
    {
      "url": "https://api.solargis.com",
      "description": "TimeSeries and TMY API endpoint"
    }
  ],
  "tags": [
    {
      "name": "Solargis Time Series API",
      "description": "Endpoints for Time Series data requests"
    },
    {
      "name": "Solargis TMY API",
      "description": "Endpoints for TMY data requests"
    },
    {
      "name": "Subscription details API",
      "description": "Get information about your subscription"
    }
  ],
  "paths": {
    "/ts/data-request": {
      "post": {
        "tags": [
          "Solargis Time Series API"
        ],
        "summary": "Get the Time Series requestId",
        "security": [
          {
            "TimeSeriesToken": []
          }
        ],
        "requestBody": {
          "required": "true",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TimeSeriesRequest"
              },
              "example": {
                "site": {
                  "latitude": "48.88375",
                  "longitude": "20.159472",
                  "siteName": "KB Enterprise Site"
                },
                "timeStep": "PT15M",
                "columns": [
                  "GHI",
                  "DNI",
                  "DIF",
                  "GHI_NOSHD",
                  "DNI_NOSHD",
                  "DIF_NOSHD",
                  "GTI_NOSHD",
                  "GTI",
                  "UVA",
                  "UVB",
                  "PAR",
                  "KT",
                  "KC",
                  "CI_FLAG",
                  "SUN_ELEVATION",
                  "SUN_AZIMUTH",
                  "PANEL_AZIMUTH",
                  "PANEL_TILT",
                  "PANEL_INC",
                  "TEMP",
                  "WS",
                  "WD",
                  "WS100",
                  "WD100",
                  "WG",
                  "RH",
                  "AP",
                  "PWAT",
                  "PREC",
                  "TD",
                  "WBT",
                  "SDWE",
                  "SFWE",
                  "PM2P5",
                  "PM10"
                ],
                "outputFormat": "SOLARGIS_JSON",
                "compressOutput": "true",
                "splitOutputByYears": "false",
                "fromDate": "AUTODETECT",
                "toDate": "LAST_MONTH",
                "timeAlignment": "CENTER",
                "utcOffset": "+01:00",
                "terrainShading": "true",
                "environment": {
                  "surfaceAlbedo": "0.12",
                  "horizon": {
                    "azimuth": [
                      "0.0",
                      "37.5",
                      "60.0",
                      "82.5",
                      "105.0",
                      "127.5",
                      "150.0",
                      "172.5",
                      "195.0",
                      "217.5",
                      "240.0",
                      "262.5",
                      "285.0",
                      "307.5",
                      "330.0",
                      "352.5"
                    ],
                    "height": [
                      "0.705",
                      "1.0588235",
                      "1.058894",
                      "1.428",
                      "0.70588764",
                      "0.0",
                      "0.0",
                      "0.0",
                      "0.0",
                      "0.0",
                      "0.0",
                      "0.0",
                      "0.0",
                      "0.0",
                      "0.0",
                      "0.0"
                    ]
                  }
                },
                "gtiConfiguration": {
                  "layout": {
                    "mounting": {
                      "type": "FIXED_ONE_ANGLE",
                      "tilt": "39"
                    }
                  }
                },
                "fileLabel": "ts_pro"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "RequestId retrieved",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RequestIdResponse"
                }
              }
            }
          },
          "401": {
            "description": "Invalid authorization",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvalidToken"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "TimeSeriesRequest": {
        "type": "object",
        "required": [
          "site",
          "timeStep",
          "columns",
          "outputFormat"
        ],
        "properties": {
          "site": {
            "type": "object",
            "description": "Geographic location of the site for which data is requested.",
            "properties": {
              "latitude": {
                "type": "number",
                "format": "double",
                "description": "Geographic latitude of the site in decimal degrees (WGS84).",
                "example": "48.88375"
              },
              "longitude": {
                "type": "number",
                "format": "double",
                "description": "Geographic longitude of the site in decimal degrees (WGS84).",
                "example": "20.159472"
              },
              "siteName": {
                "type": "string",
                "description": "Human-readable label identifying the site in output files and logs.",
                "example": "Solargis Testing request KB"
              }
            }
          },
          "timeStep": {
            "type": "string",
            "enum": [
              "PT1M",
              "PT15M",
              "PT60M",
              "P1D",
              "P1M",
              "P1Y"
            ],
            "description": "Temporal resolution of the output data; available options depend on your subscription.",
            "example": "PT15M"
          },
          "columns": {
            "type": "array",
            "description": "List of meteorological and solar parameters to include in the output. RH, AP, and PWAT are available for ENTERPRISE subscriptions only.",
            "items": {
              "type": "string",
              "enum": [
                "GHI",
                "DNI",
                "DIF",
                "GHI_NOSHD",
                "DNI_NOSHD",
                "DIF_NOSHD",
                "GTI_NOSHD",
                "GTI",
                "CI_FLAG",
                "SUN_ELEVATION",
                "SUN_AZIMUTH",
                "PANEL_AZIMUTH",
                "PANEL_TILT",
                "PANEL_INC",
                "TEMP",
                "WS",
                "WD",
                "WS100",
                "WD100",
                "WG",
                "RH",
                "AP",
                "PWAT",
                "PREC",
                "TD",
                "WBT",
                "SDWE",
                "SFWE",
                "UVA",
                "UVB",
                "PAR",
                "KT",
                "KC",
                "PM2P5",
                "PM10"
              ]
            },
            "example": [
              "GHI",
              "DNI",
              "TEMP"
            ]
          },
          "outputFormat": {
            "type": "string",
            "enum": [
              "SOLARGIS_JSON",
              "SOLARGIS_CSV"
            ],
            "description": "Output file format for the time series data.",
            "example": "SOLARGIS_JSON"
          },
          "compressOutput": {
            "type": "boolean",
            "default": "false",
            "description": "When true, the output file is compressed as a ZIP archive."
          },
          "splitOutputByYears": {
            "type": "boolean",
            "default": "false",
            "description": "When true, splits the output into one file per year; requires `compressOutput` to be set to true."
          },
          "fromDate": {
            "type": "string",
            "format": "string",
            "pattern": "^(AUTODETECT|\\d{4}-\\d{2}-\\d{2})$",
            "description": "Start date in ISO 8601 format (YYYY-MM-DD). Use `AUTODETECT` to automatically select the earliest available start date.",
            "example": "AUTODETECT"
          },
          "toDate": {
            "type": "string",
            "format": "string",
            "example": "2023-12-31",
            "pattern": "^(LAST_MONTH|LAST_YEAR|\\d{4}-\\d{2}-\\d{2})$",
            "description": "End date in ISO 8601 format (YYYY-MM-DD). Use `LAST_MONTH` or `LAST_YEAR` for relative date selection."
          },
          "timeAlignment": {
            "type": "string",
            "enum": [
              "CENTER",
              "LEFT",
              "RIGHT"
            ],
            "default": "CENTER",
            "description": "Defines whether timestamps represent the center, start (left), or end (right) of each time interval.",
            "example": "CENTER"
          },
          "utcOffset": {
            "type": "string",
            "pattern": "^[+-]\\d{2}:\\d{2}$",
            "x-format": {
              "hours": {
                "minimum": "-14",
                "maximum": "14"
              },
              "minutes": {
                "enum": [
                  "0",
                  "30"
                ]
              }
            },
            "description": "UTC offset for the output timestamps in ±HH:MM format.",
            "example": "+01:00"
          },
          "terrainShading": {
            "type": "boolean",
            "default": "false",
            "description": "When true, applies terrain horizon shading to irradiance calculations."
          },
          "environment": {
            "type": "object",
            "description": "Site-specific environmental parameters that influence irradiance calculations.",
            "properties": {
              "surfaceAlbedo": {
                "oneOf": [
                  {
                    "type": "number",
                    "example": "0.12"
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "number"
                    },
                    "minItems": "12",
                    "maxItems": "12",
                    "example": [
                      "0.12",
                      "0.13",
                      "0.14",
                      "0.15",
                      "0.16",
                      "0.17",
                      "0.18",
                      "0.17",
                      "0.16",
                      "0.15",
                      "0.14",
                      "0.13"
                    ]
                  }
                ],
                "description": "Surface albedo as a single annual value or an array of 12 monthly values (Jan–Dec)."
              },
              "horizon": {
                "type": "object",
                "description": "Custom horizon profile defined by azimuth–height pairs to account for local obstructions.",
                "properties": {
                  "azimuth": {
                    "type": "array",
                    "description": "Array of azimuth angles in degrees (0–360, measured clockwise from north) defining the horizon profile.",
                    "items": {
                      "type": "number"
                    }
                  },
                  "height": {
                    "type": "array",
                    "description": "Array of horizon elevation angles in degrees corresponding to each azimuth point.",
                    "items": {
                      "type": "number"
                    }
                  }
                }
              }
            }
          },
          "gtiConfiguration": {
            "$ref": "#/components/schemas/gtiConfigurationSchema"
          },
          "fileLabel": {
            "type": "string",
            "description": "Short identifier prepended to output file names for easy recognition.",
            "example": "Integration_example"
          }
        }
      },
      "RequestIdResponse": {
        "type": "object",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "Unique identifier used to retrieve the processed data in a subsequent GET request."
          }
        }
      },
      "InvalidToken": {
        "type": "object",
        "description": "Invalid authorization",
        "properties": {
          "error": {
            "type": "string",
            "description": "Machine-readable error code indicating the authentication failure reason.",
            "example": "token.invalid"
          }
        }
      },
      "gtiConfigurationSchema": {
        "type": "object",
        "description": "Panel mounting configuration used to compute plane-of-array irradiance (GTI).",
        "properties": {
          "layout": {
            "type": "object",
            "description": "Physical layout of the PV panel installation.",
            "properties": {
              "mounting": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/FixedOneAngleMounting"
                  },
                  {
                    "$ref": "#/components/schemas/TrackerOneAxisHorizontalMounting"
                  },
                  {
                    "$ref": "#/components/schemas/TrackerOneAxisInclinedMounting"
                  },
                  {
                    "$ref": "#/components/schemas/TrackerOneAxisVerticalMounting"
                  },
                  {
                    "$ref": "#/components/schemas/TrackerTwoAxisMounting"
                  }
                ],
                "description": "Mounting system type and its associated configuration parameters.",
                "discriminator": {
                  "propertyName": "type",
                  "mapping": {
                    "FIXED_ONE_ANGLE": "#/components/schemas/FixedOneAngleMounting",
                    "TRACKER_ONE_AXIS_HORIZONTAL": "#/components/schemas/TrackerOneAxisHorizontalMounting",
                    "TRACKER_ONE_AXIS_INCLINED": "#/components/schemas/TrackerOneAxisInclinedMounting",
                    "TRACKER_ONE_AXIS_VERTICAL": "#/components/schemas/TrackerOneAxisVerticalMounting",
                    "TRACKER_TWO_AXIS": "#/components/schemas/TrackerTwoAxisMounting"
                  }
                }
              },
              "relativeSpacing": {
                "type": "number",
                "format": "float",
                "minimum": "0.1",
                "description": "Row-to-row spacing relative to the panel height, used to model inter-row shading."
              }
            }
          }
        }
      },
      "FixedOneAngleMounting": {
        "type": "object",
        "description": "Fixed-tilt mounting system with a single static panel inclination angle.",
        "required": [
          "type",
          "tilt"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "FIXED_ONE_ANGLE"
            ],
            "description": "Identifies the mounting type as fixed single-angle.",
            "example": "FIXED_ONE_ANGLE"
          },
          "tilt": {
            "type": "number",
            "minimum": "0",
            "maximum": "90",
            "description": "Panel tilt angle in degrees from horizontal (0° = flat, 90° = vertical).",
            "example": "39"
          }
        }
      },
      "TrackerOneAxisHorizontalMounting": {
        "type": "object",
        "description": "Single-axis horizontal tracker where the rotation axis is parallel to the ground.",
        "required": [
          "type",
          "backtracking",
          "rotationLimitEast",
          "rotationLimitWest"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "TRACKER_ONE_AXIS_HORIZONTAL"
            ],
            "description": "Identifies the mounting type as a horizontal single-axis tracker."
          },
          "backtracking": {
            "type": "boolean",
            "description": "When true, the tracker uses backtracking to avoid inter-row shading at low sun angles."
          },
          "rotationLimitEast": {
            "type": "number",
            "minimum": "-180",
            "maximum": "0",
            "description": "Maximum rotation angle in degrees toward the east (negative value).",
            "example": "-50"
          },
          "rotationLimitWest": {
            "type": "number",
            "minimum": "0",
            "maximum": "180",
            "description": "Maximum rotation angle in degrees toward the west (positive value).",
            "example": "50"
          }
        }
      },
      "TrackerOneAxisInclinedMounting": {
        "type": "object",
        "description": "Single-axis tracker with an inclined rotation axis tilted from horizontal.",
        "required": [
          "type",
          "axisTilt",
          "backtracking",
          "rotationLimitEast",
          "rotationLimitWest"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "TRACKER_ONE_AXIS_INCLINED"
            ],
            "description": "Identifies the mounting type as an inclined single-axis tracker."
          },
          "axisTilt": {
            "type": "number",
            "minimum": "0",
            "maximum": "90",
            "description": "Tilt angle of the tracker rotation axis from horizontal, in degrees.",
            "example": "30"
          },
          "backtracking": {
            "type": "boolean",
            "description": "When true, the tracker uses backtracking to avoid inter-row shading at low sun angles."
          },
          "rotationLimitEast": {
            "type": "number",
            "description": "Maximum rotation angle in degrees toward the east (negative value).",
            "example": "-50"
          },
          "rotationLimitWest": {
            "type": "number",
            "description": "Maximum rotation angle in degrees toward the west (positive value).",
            "example": "50"
          }
        }
      },
      "TrackerOneAxisVerticalMounting": {
        "type": "object",
        "description": "Single-axis vertical tracker (azimuth tracker) that rotates around a vertical axis.",
        "required": [
          "type",
          "tilt",
          "azimuthLimitEast",
          "azimuthLimitWest",
          "backtracking"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "TRACKER_ONE_AXIS_VERTICAL"
            ],
            "description": "Identifies the mounting type as a vertical single-axis (azimuth) tracker."
          },
          "tilt": {
            "type": "number",
            "minimum": "0",
            "maximum": "90",
            "description": "Fixed panel tilt angle in degrees from horizontal.",
            "example": "30"
          },
          "azimuthLimitEast": {
            "type": "number",
            "minimum": "-180",
            "maximum": "0",
            "description": "Maximum azimuth rotation limit toward the east in degrees (negative value).",
            "example": "-120"
          },
          "azimuthLimitWest": {
            "type": "number",
            "minimum": "0",
            "maximum": "180",
            "description": "Maximum azimuth rotation limit toward the west in degrees (positive value).",
            "example": "120"
          },
          "backtracking": {
            "type": "boolean",
            "description": "When true, the tracker uses backtracking to avoid inter-row shading at low sun angles."
          }
        }
      },
      "TrackerTwoAxisMounting": {
        "type": "object",
        "description": "Two-axis tracker that independently adjusts both tilt and azimuth to follow the sun.",
        "required": [
          "type",
          "backtracking",
          "tiltLimitMin",
          "tiltLimitMax",
          "azimuthLimitEast",
          "azimuthLimitWest"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "TRACKER_TWO_AXIS"
            ],
            "description": "Identifies the mounting type as a two-axis tracker."
          },
          "backtracking": {
            "type": "boolean",
            "description": "When true, the tracker uses backtracking to avoid inter-row shading at low sun angles."
          },
          "tiltLimitMin": {
            "type": "number",
            "minimum": "0",
            "maximum": "90",
            "description": "Minimum allowable tilt angle in degrees from horizontal.",
            "example": "10"
          },
          "tiltLimitMax": {
            "type": "number",
            "minimum": "0",
            "maximum": "90",
            "description": "Maximum allowable tilt angle in degrees from horizontal.",
            "example": "90"
          },
          "azimuthLimitEast": {
            "type": "number",
            "description": "Maximum azimuth rotation limit toward the east in degrees (negative value).",
            "example": "-90"
          },
          "azimuthLimitWest": {
            "type": "number",
            "description": "Maximum azimuth rotation limit toward the west in degrees (positive value).",
            "example": "90"
          }
        }
      }
    },
    "securitySchemes": {
      "TimeSeriesToken": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Enter your Solargis TimeSeries Bearer token.  Example: \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n"
      }
    }
  }
}
````