> ## 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 TMY requestId

## OpenAPI

````json POST /tmy/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": {
    "/tmy/data-request": {
      "post": {
        "tags": [
          "Solargis TMY API"
        ],
        "summary": "Get the TMY requestId",
        "security": [
          {
            "TMYToken": []
          }
        ],
        "requestBody": {
          "required": "true",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TMYRequest"
              },
              "example": {
                "latitude": "48.61259",
                "longitude": "20.827079",
                "siteName": "KB Pro Site",
                "timeStep": "PT60M",
                "tmyScenario": "P50",
                "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"
                    }
                  }
                },
                "compressOutput": "true",
                "outputFormats": [
                  "SOLARGIS_CSV",
                  "SOLARGIS_JSON",
                  "SAM",
                  "HELIOSCOPE"
                ],
                "fileLabel": "tmy_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": {
      "TMYRequest": {
        "type": "object",
        "required": [
          "latitude",
          "longitude",
          "timeStep",
          "tmyScenario",
          "outputFormats",
          "siteName"
        ],
        "properties": {
          "latitude": {
            "type": "number",
            "format": "double",
            "description": "Geographic latitude of the site in decimal degrees (WGS84).",
            "example": "48.883753"
          },
          "longitude": {
            "type": "number",
            "format": "double",
            "description": "Geographic longitude of the site in decimal degrees (WGS84).",
            "example": "20.159472"
          },
          "timeStep": {
            "type": "string",
            "enum": [
              "PT60M",
              "PT15M",
              "PT1M"
            ],
            "example": "PT60M",
            "description": "Temporal resolution of the output data."
          },
          "tmyScenario": {
            "type": "string",
            "enum": [
              "P50"
            ],
            "description": "Statistical exceedance scenario for the TMY dataset; P50 represents the median energy yield.",
            "example": "P50"
          },
          "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"
                    }
                  }
                }
              }
            }
          },
          "outputFormats": {
            "type": "array",
            "description": "List of output file formats to generate for the TMY data.",
            "items": {
              "type": "string",
              "enum": [
                "SOLARGIS_JSON",
                "SOLARGIS_CSV",
                "SAM"
              ]
            },
            "example": [
              "SOLARGIS_JSON"
            ]
          },
          "siteName": {
            "type": "string",
            "description": "Human-readable label identifying the site in output files and logs.",
            "example": "Solargis Testing request KB"
          },
          "fileLabel": {
            "type": "string",
            "description": "Short identifier prepended to output file names for easy recognition.",
            "example": "pro_01"
          },
          "gtiConfiguration": {
            "$ref": "#/components/schemas/gtiConfigurationSchema"
          },
          "compressOutput": {
            "type": "boolean",
            "description": "When true, the output file is compressed as a ZIP archive.",
            "default": "false"
          }
        }
      },
      "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": {
      "TMYToken": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Enter your Solargis TMY Bearer token.\n"
      }
    }
  }
}
````