# Parameters

## Request parameters

| Parameter      | Description                                                                 | Default | Required |
| -------------- | --------------------------------------------------------------------------- | ------- | -------- |
| `apikey`       | Unique code used to access the API.                                         | —       | Yes      |
| `version`      | Version of the API.                                                         | v1      | Yes      |
| `display_mode` | A numerical value that can change the resultant rendered tiles.             | —       | No       |
| `locations`    | Boolean value. When true, returns a bounding box for the requested feature. | false   | No       |
| `toplat`       | The northern latitude that defines a bounding box.                          | —       | Yes      |
| `bottomlat`    | The southern latitude that defines a bounding box.                          | —       | Yes      |
| `rightlon`     | The eastern longitude that defines a bounding box.                          | —       | Yes      |
| `leftlon`      | The western longitude that defines a bounding box.                          | —       | Yes      |
| `zoom`         | Viewing height or distance the viewer appears to be from the map surface.   | —       | Yes      |
| `attribute`    | Returns JSON query attribution information for the source data.             | false   | No       |
| `products`     | The full code of a specific Future Radar product or products.               | —       | Yes      |
| `x1`           | The top left X coordinate of a bounding box.                                | —       | Yes      |
| `y1`           | The top left Y coordinate of a bounding box.                                | —       | Yes      |
| `x2`           | The bottom right X coordinate of a bounding box.                            | —       | Yes      |
| `y2`           | The bottom right Y coordinate of a bounding box.                            | —       | Yes      |

---

## Product lists response parameters

| Field                       | Type    | Description                                                                                        |
| --------------------------- | ------- | -------------------------------------------------------------------------------------------------- |
| `products`                  | array   | An array containing the full list of products.                                                     |
| `products[].color`          | string  | Hexadecimal code for the color that illustrates the specific product's coverage area.              |
| `products[].location`       | object  | An object containing the bounding box limits.                                                      |
| `products[].location.east`  | number  | Eastern bounding longitudinal value.                                                               |
| `products[].location.north` | number  | Northern bounding latitudinal value.                                                               |
| `products[].location.south` | number  | Southern bounding latitudinal value.                                                               |
| `products[].location.west`  | number  | Western bounding longitudinal value.                                                               |
| `products[].major`          | integer | The first part of the product ID number. Combined with the minor value and separated with a dash.  |
| `products[].minor`          | integer | The second part of the product ID number. Combined with the major value and separated with a dash. |
| `products[].name`           | string  | The name of the product in English.                                                                |
| `url`                       | string  | The root URL for the current API system.                                                           |

---

## Product frames

| Field    | Type   | Description                              |
| -------- | ------ | ---------------------------------------- |
| `frames` | array  | An array containing a list of frames.    |
| `url`    | string | The root URL for the current API system. |