Records & metadata
Besides listing a dataset, the API can return one record, describe a dataset's fields and report what changed between data snapshots.
Get one record#
Records are addressed by canonical ID. A reviewed legacy ID may also resolve to the same canonical record.
curl https://gzw-data.dev/api/v1/weapons/ak-12The JavaScript client exposes the same route through dataset.get(id).
Reviewed legacy IDs resolve to the canonical record ID. Records may also include an additive numeric_values object for unit-bearing fields. Original source strings are retained.
Dataset metadata and schema#
Inspect generated field metadata without downloading a full dataset.
curl https://gzw-data.dev/api/v1/metadata/weapons
curl https://gzw-data.dev/api/v1/schema/weaponsMetadata returns the item count, observed fields, detected types, optional or nullable flags, a stable example value, the last scrape time and the wiki pages each dataset came from. Use /api/v1/schema/{dataset} when a code generator or validator needs one machine-readable schema.
Context routes#
Use related routes to combine datasets without guessing relationships. The item context endpoint reports dataset references found in the current data.
curl https://gzw-data.dev/api/v1/items/advanced-tracking-tag/contextReferences are based on the current dataset contents and are not guaranteed gameplay relationships.
Version and change history#
Inspect the API version, current data snapshot, dataset count and canonical integration links without loading a dataset.
curl https://gzw-data.dev/api/v1/version
curl https://gzw-data.dev/api/v1/changeschanges compares dataset counts with the latest stored snapshot. The first snapshot reports no changes until a second one exists. The data status page shows the same information live.