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

# Network status

> Aggregate status for the NYC preview dataset.

Returns aggregate status for the New York City preview dataset.

```bash theme={null}
curl -H "x-api-key: linkr_test_demo01" \
  "https://linkrmap.com/api/v1/network/status"
```

## Response

```json theme={null}
{
  "data": {
    "status": "operational",
    "totalNodes": 78,
    "activeNodes": 76,
    "avgLatency": "12ms",
    "avgUptime": "94.2%",
    "regions": [
      { "name": "Manhattan", "nodes": 42, "status": "operational" },
      { "name": "Brooklyn", "nodes": 20, "status": "operational" },
      { "name": "Queens", "nodes": 10, "status": "operational" },
      { "name": "Bronx", "nodes": 6, "status": "operational" }
    ]
  }
}
```

## Fields

| Field         | Type   | Notes                                                   |
| ------------- | ------ | ------------------------------------------------------- |
| `status`      | string | Always `operational` for the preview dataset            |
| `totalNodes`  | number | Total hotspots in the dataset (78)                      |
| `activeNodes` | number | Hardcoded as `totalNodes - 2`                           |
| `avgLatency`  | string | Hardcoded `"12ms"`                                      |
| `avgUptime`   | string | Mean of the dataset's `uptime` values, e.g. `"94.2%"`   |
| `regions`     | array  | Per-borough counts (Manhattan, Brooklyn, Queens, Bronx) |

<Note>
  `activeNodes` and `avgLatency` are fixed values in the preview dataset, not live
  measurements. Live monitoring is on the roadmap; see [Product status](/docs/introduction/status).
</Note>


## OpenAPI

````yaml GET /api/v1/network/status
openapi: 3.1.0
info:
  title: Linkr Public API
  version: 1.0.0
  description: >-
    Read-only API serving the Linkr New York City preview dataset (78 hotspots).
    No write operations exist. The API key is a shape-checked demo key, not an
    issued credential.
servers:
  - url: https://linkrmap.com
    description: Production
security:
  - apiKey: []
paths:
  /api/v1/network/status:
    get:
      summary: Network status
      description: Returns aggregate status for the NYC preview dataset.
      operationId: networkStatus
      responses:
        '200':
          description: Network status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/NetworkStatus'
        '401':
          description: Missing or malformed API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    NetworkStatus:
      type: object
      properties:
        status:
          type: string
          example: operational
        totalNodes:
          type: integer
          example: 78
        activeNodes:
          type: integer
          description: Hardcoded as totalNodes - 2.
          example: 76
        avgLatency:
          type: string
          description: Hardcoded string.
          example: 12ms
        avgUptime:
          type: string
          example: 94.2%
        regions:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                example: Manhattan
              nodes:
                type: integer
                example: 42
              status:
                type: string
                example: operational
    Error:
      type: object
      properties:
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: >-
            Invalid or missing API key. Include x-api-key header with a valid
            key (linkr_test_* or linkr_live_*).
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Value must match linkr_(test|live)_[a-zA-Z0-9]{6,}. This is a shape
        check, not an issued credential.

````