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

# Get account positions freshness JSON Schema

> Get account positions freshness JSON Schema contract. Includes parameters, response shapes, examples, and implementation notes from the 0xArchive contract.

Source OpenAPI: 0xArchive API 1.8.0; 227 paths; 217 component schemas.

Freshness of each account positions product: latest live and hourly snapshots, live age, and how far the change log is built and final. Lighter on Robinhood Chain is listed once its positions routes are public.

## Route Metadata

| Field | Value |
| - | - |
| Method | `GET` |
| Path | `/v1/data-quality/positions` |
| operationId | `getPositionsFreshness` |
| Tag | Data Quality |
| Family | Data Quality |
| Deprecated or legacy | no |

## Human endpoint reference

Open [`GET /v1/data-quality/positions`](/api-reference/data-quality/get-account-positions-freshness) for authentication, parameters, responses, and examples.

## Response Contracts

### Status 200

Positions freshness per product

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getPositionsFreshness response 200",
  "description": "Freshness of every positions product.",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "description": "Freshness of one positions product.",
        "type": "object",
        "required": [
          "built_through",
          "finalized_through",
          "hourly_snapshot_ts",
          "live_age_seconds",
          "live_quality",
          "live_snapshot_ts",
          "product",
          "stale",
          "venue"
        ],
        "properties": {
          "built_through": {
            "description": "Every event before this instant is built into the change log and as-of state.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "finalized_through": {
            "description": "Every event before this instant is final and will not be re-derived.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "hourly_snapshot_ts": {
            "description": "Latest committed hourly snapshot.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "live_age_seconds": {
            "description": "Age of the latest live snapshot in seconds.",
            "type": "integer",
            "format": "int64",
            "nullable": true,
            "example": 94
          },
          "live_quality": {
            "description": "Quality of the latest live snapshot.",
            "type": "string",
            "nullable": true,
            "example": "complete"
          },
          "live_snapshot_ts": {
            "description": "Latest live snapshot.",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "product": {
            "description": "`core`, `hip3`, `lighter`, or `rh_lighter`.",
            "type": "string",
            "example": "core"
          },
          "stale": {
            "description": "True when the latest live snapshot is older than 12 minutes, or there is none.",
            "type": "boolean",
            "example": false
          },
          "venue": {
            "description": "`hyperliquid`, `lighter`, or `rh_lighter`.",
            "type": "string",
            "example": "hyperliquid"
          }
        }
      }
    },
    "meta": {
      "description": "Response metadata",
      "type": "object",
      "properties": {
        "count": {
          "description": "Number of records returned",
          "type": "integer"
        },
        "coverage_from": {
          "description": "Earliest coverage for the requested symbol and data type. Present only when the requested window ends before coverage begins.",
          "type": "string",
          "format": "date-time"
        },
        "has_more": {
          "description": "Present on cursor-paged routes: true when another page exists. `next_cursor` is present exactly when it is true.",
          "type": "boolean"
        },
        "next_cursor": {
          "description": "Cursor for pagination (timestamp). Use this value as the `cursor` parameter to fetch the next page of results.",
          "type": "string",
          "nullable": true
        },
        "notice": {
          "description": "Human-readable advisory about the response. Used when the requested window ends before coverage begins for the symbol, and on CVD responses that are one page of several; may carry other advisories in future.",
          "type": "string"
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        },
        "symbol": {
          "description": "Present on per-symbol routes: the symbol the response covers.",
          "type": "string"
        },
        "venue": {
          "description": "Present on per-symbol routes: the venue the response covers, for example `hyperliquid` or `hip3`.",
          "type": "string"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}
```

### Status 401

Authentication required

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getPositionsFreshness response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 401,
  "error": "Missing authentication credentials. Provide X-API-Key header or Bearer token.",
  "error_code": "unauthorized",
  "request_id": "71ed4b6f-63ef-4ae1-a123-07ffa47c1c14",
  "success": false
}
```

### Status 429

Rate limit exceeded

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getPositionsFreshness response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 429,
  "error": "Rate limit exceeded"
}
```

### Status 503

Positions, pagination, or an as-of reconstruction are temporarily unavailable (`error_code` `positions_unavailable`, `pagination_unavailable`, or `reconstruction_unavailable`). Retry shortly.

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getPositionsFreshness response 503",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 503,
  "error": "Account positions are not available right now.",
  "error_code": "positions_unavailable"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.