TNM Access API

https://tnmaccess.nationalmap.gov/api/v1/docs
Admin
TNM Access API is a web service that exposes information about The National Map products, datasets,...
Tokens:1,500
Snippets:9
Trust Score:9.4
Update:9 months ago
Show doc for...
Tokens:
Raw
### Products API

Source: https://tnmaccess.nationalmap.gov/api/v1/docs/index

This endpoint retrieves information about the pre-staged downloadable products available through The National Map.

```APIDOC
## GET /products

### Description
Obtain product results.

### Method
GET

### Endpoint
https://tnmaccess.nationalmap.gov/api/v1/products

### Parameters
#### Query Parameters
- **keyword** (string) - Optional - Keyword to filter products.
- **datasetId** (string) - Optional - Filter products by dataset ID.
- **productId** (string) - Optional - Filter products by product ID.

### Request Example
```json
{
  "example": "GET /products?keyword=elevation&datasetId=1"
}
```

### Response
#### Success Response (200)
- **products** (array) - A list of product objects.
  - **productId** (string) - The unique identifier for the product.
  - **productName** (string) - The name of the product.
  - **description** (string) - A description of the product.
  - **datasetIds** (array) - List of dataset IDs this product belongs to.

#### Response Example
```json
{
  "example": {
    "products": [
      {
        "productId": "55E05307-0A6B-471E-8C2D-7A35828A383C",
        "productName": "100K Topo",
        "description": "100K Topographic Maps.",
        "datasetIds": ["1", "2"]
      }
    ]
  }
}
```
```

--------------------------------

### Datasets API

Source: https://tnmaccess.nationalmap.gov/api/v1/docs/index

This endpoint retrieves information about datasets, which organize products by recognizable themes and collections of data.

```APIDOC
## GET /datasets

### Description
Obtain dataset results.

### Method
GET

### Endpoint
https://tnmaccess.nationalmap.gov/api/v1/datasets

### Parameters
#### Query Parameters
- **keyword** (string) - Optional - Keyword to filter datasets.

### Request Example
```json
{
  "example": "GET /datasets?keyword=hydrography"
}
```

### Response
#### Success Response (200)
- **datasets** (array) - A list of dataset objects.
  - **datasetId** (string) - The unique identifier for the dataset.
  - **datasetName** (string) - The name of the dataset.
  - **description** (string) - A description of the dataset.

#### Response Example
```json
{
  "example": {
    "datasets": [
      {
        "datasetId": "1",
        "datasetName": "Hydrography",
        "description": "Surface water features including rivers, lakes, and streams."
      }
    ]
  }
}
```
```

--------------------------------

### Notifications API

Source: https://tnmaccess.nationalmap.gov/api/v1/docs/index

This endpoint provides information about new features, data availability, and upcoming maintenance windows.

```APIDOC
## GET /notifications

### Description
Obtain notification results.

### Method
GET

### Endpoint
https://tnmaccess.nationalmap.gov/api/v1/notifications

### Parameters
#### Query Parameters
- **since** (string) - Optional - Filter notifications since a specific date (YYYY-MM-DD).

### Request Example
```json
{
  "example": "GET /notifications?since=2023-01-01"
}
```

### Response
#### Success Response (200)
- **notifications** (array) - A list of notification objects.
  - **notificationId** (string) - The unique identifier for the notification.
  - **title** (string) - The title of the notification.
  - **message** (string) - The content of the notification.
  - **publishDate** (string) - The date the notification was published.

#### Response Example
```json
{
  "example": {
    "notifications": [
      {
        "notificationId": "123",
        "title": "New Data Available",
        "message": "New 100K Topo data has been released for Region X.",
        "publishDate": "2023-10-27T10:00:00Z"
      }
    ]
  }
}
```
```

--------------------------------

### Map Services API

Source: https://tnmaccess.nationalmap.gov/api/v1/docs/index

This endpoint retrieves information about available map and data services, primarily Web Map Services.

```APIDOC
## GET /map_services

### Description
Obtain map services results.

### Method
GET

### Endpoint
https://tnmaccess.nationalmap.gov/api/v1/map_services

### Parameters
#### Query Parameters
- **serviceType** (string) - Optional - Filter by service type (e.g., 'WMS', 'WFS', 'WCS').
- **datasetId** (string) - Optional - Filter services associated with a specific dataset ID.

### Request Example
```json
{
  "example": "GET /map_services?serviceType=WMS&datasetId=3"
}
```

### Response
#### Success Response (200)
- **mapServices** (array) - A list of map service objects.
  - **serviceId** (string) - The unique identifier for the service.
  - **serviceName** (string) - The name of the service.
  - **serviceUrl** (string) - The URL to access the service.
  - **serviceType** (string) - The type of service (e.g., WMS, WFS).
  - **datasetIds** (array) - List of dataset IDs this service is associated with.

#### Response Example
```json
{
  "example": {
    "mapServices": [
      {
        "serviceId": "MS001",
        "serviceName": "TNM Hydrography WMS",
        "serviceUrl": "https://basemap.nationalmap.gov/arcgis/services/USGSImageryOnly/MapServer/WMSServer?request=GetCapabilities&service=WMS",
        "serviceType": "WMS",
        "datasetIds": ["1"]
      }
    ]
  }
}
```
```
Tokens:
Raw