GeoGridAPI · JSON-LD Context

Geogridapi Io Context

JSON-LD context defining the semantic vocabulary for Geogridapi Io from GeoGridAPI.

23 Classes 79 Properties 4 Namespaces

View Context View on GitHub

Namespaces

schema: https://schema.org/

xsd: http://www.w3.org/2001/XMLSchema#

dcterms: http://purl.org/dc/terms/

geogridapi: https://geogridapi.io/schema#

Classes

Error Place Center GridFormat GridTarget GridSummary TopListing GridPoint Competitor PreviousGrid Grid GridList PlaceList Estimate HistoryEntry History Balance BatchItem Batch CreateScheduleRequest Schedule GridError PlaceRef

Properties

Property	Type	Container
error
place_id	string
name	string
address	string
lat	decimal
lng	decimal
shape	string
size	integer
density	string
radius_km	decimal
language	string
country	string
webhook_url	string
query	string
center	reference
keyword	string
average_rank	decimal
average_rank_with_misses	decimal
top3_points	integer
found_points	integer
rank	integer
row	integer
col	integer
top		list
first_points	integer
ahead_points	integer
grid_id	string
created_at	dateTime
changes
ranks		list
rank_changes		list
points
id	string
object	string
status	string
mode	string
source	string
api_key_id	string
place	reference
rows	integer
cols	integer
points_total	integer
points_charged	integer
summary	reference
competitors		list
previous	reference
webhook
completed_at	dateTime
data		list
has_more	boolean
next_before	string
points_at_sea	integer
exact	boolean
credits	integer
balance	integer
balance_after	integer
enough	boolean
reference_grid_id	string
change
index	integer
items_count	integer
counts
credits_estimated	integer
credits_charged	integer
items		list
launched_at	dateTime
frequency	string
weekday	integer
month_day	integer
stopped_reason	string
points_per_run	integer
credits_per_month	integer
next_run_at	dateTime
last_run_at	dateTime
last_grid_id	string
source_grid_id	string
runs_count	integer
code	string
message	string

JSON-LD Document

{
  "@context": {
    "@vocab": "https://geogridapi.io/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "geogridapi": "https://geogridapi.io/schema#",
    "Error": "geogridapi:Error",
    "error": {
      "@id": "geogridapi:error"
    },
    "Place": "geogridapi:Place",
    "place_id": {
      "@id": "geogridapi:place_id",
      "@type": "xsd:string"
    },
    "name": {
      "@id": "geogridapi:name",
      "@type": "xsd:string"
    },
    "address": {
      "@id": "geogridapi:address",
      "@type": "xsd:string"
    },
    "lat": {
      "@id": "geogridapi:lat",
      "@type": "xsd:decimal"
    },
    "lng": {
      "@id": "geogridapi:lng",
      "@type": "xsd:decimal"
    },
    "Center": "geogridapi:Center",
    "GridFormat": "geogridapi:GridFormat",
    "shape": {
      "@id": "geogridapi:shape",
      "@type": "xsd:string"
    },
    "size": {
      "@id": "geogridapi:size",
      "@type": "xsd:integer"
    },
    "density": {
      "@id": "geogridapi:density",
      "@type": "xsd:string"
    },
    "radius_km": {
      "@id": "geogridapi:radius_km",
      "@type": "xsd:decimal"
    },
    "language": {
      "@id": "geogridapi:language",
      "@type": "xsd:string"
    },
    "country": {
      "@id": "geogridapi:country",
      "@type": "xsd:string"
    },
    "webhook_url": {
      "@id": "geogridapi:webhook_url",
      "@type": "xsd:string"
    },
    "GridTarget": "geogridapi:GridTarget",
    "query": {
      "@id": "geogridapi:query",
      "@type": "xsd:string"
    },
    "center": {
      "@id": "geogridapi:center",
      "@type": "@id"
    },
    "keyword": {
      "@id": "geogridapi:keyword",
      "@type": "xsd:string"
    },
    "GridSummary": "geogridapi:GridSummary",
    "average_rank": {
      "@id": "geogridapi:average_rank",
      "@type": "xsd:decimal"
    },
    "average_rank_with_misses": {
      "@id": "geogridapi:average_rank_with_misses",
      "@type": "xsd:decimal"
    },
    "top3_points": {
      "@id": "geogridapi:top3_points",
      "@type": "xsd:integer"
    },
    "found_points": {
      "@id": "geogridapi:found_points",
      "@type": "xsd:integer"
    },
    "TopListing": "geogridapi:TopListing",
    "rank": {
      "@id": "geogridapi:rank",
      "@type": "xsd:integer"
    },
    "GridPoint": "geogridapi:GridPoint",
    "row": {
      "@id": "geogridapi:row",
      "@type": "xsd:integer"
    },
    "col": {
      "@id": "geogridapi:col",
      "@type": "xsd:integer"
    },
    "top": {
      "@id": "geogridapi:top",
      "@container": "@list"
    },
    "Competitor": "geogridapi:Competitor",
    "first_points": {
      "@id": "geogridapi:first_points",
      "@type": "xsd:integer"
    },
    "ahead_points": {
      "@id": "geogridapi:ahead_points",
      "@type": "xsd:integer"
    },
    "PreviousGrid": "geogridapi:PreviousGrid",
    "grid_id": {
      "@id": "geogridapi:grid_id",
      "@type": "xsd:string"
    },
    "created_at": {
      "@id": "geogridapi:created_at",
      "@type": "xsd:dateTime"
    },
    "changes": {
      "@id": "geogridapi:changes"
    },
    "ranks": {
      "@id": "geogridapi:ranks",
      "@container": "@list"
    },
    "rank_changes": {
      "@id": "geogridapi:rank_changes",
      "@container": "@list"
    },
    "points": {
      "@id": "geogridapi:points"
    },
    "Grid": "geogridapi:Grid",
    "id": {
      "@id": "geogridapi:id",
      "@type": "xsd:string"
    },
    "object": {
      "@id": "geogridapi:object",
      "@type": "xsd:string"
    },
    "status": {
      "@id": "geogridapi:status",
      "@type": "xsd:string"
    },
    "mode": {
      "@id": "geogridapi:mode",
      "@type": "xsd:string"
    },
    "source": {
      "@id": "geogridapi:source",
      "@type": "xsd:string"
    },
    "api_key_id": {
      "@id": "geogridapi:api_key_id",
      "@type": "xsd:string"
    },
    "place": {
      "@id": "geogridapi:place",
      "@type": "@id"
    },
    "rows": {
      "@id": "geogridapi:rows",
      "@type": "xsd:integer"
    },
    "cols": {
      "@id": "geogridapi:cols",
      "@type": "xsd:integer"
    },
    "points_total": {
      "@id": "geogridapi:points_total",
      "@type": "xsd:integer"
    },
    "points_charged": {
      "@id": "geogridapi:points_charged",
      "@type": "xsd:integer"
    },
    "summary": {
      "@id": "geogridapi:summary",
      "@type": "@id"
    },
    "competitors": {
      "@id": "geogridapi:competitors",
      "@container": "@list"
    },
    "previous": {
      "@id": "geogridapi:previous",
      "@type": "@id"
    },
    "webhook": {
      "@id": "geogridapi:webhook"
    },
    "completed_at": {
      "@id": "geogridapi:completed_at",
      "@type": "xsd:dateTime"
    },
    "GridList": "geogridapi:GridList",
    "data": {
      "@id": "geogridapi:data",
      "@container": "@list"
    },
    "has_more": {
      "@id": "geogridapi:has_more",
      "@type": "xsd:boolean"
    },
    "next_before": {
      "@id": "geogridapi:next_before",
      "@type": "xsd:string"
    },
    "PlaceList": "geogridapi:PlaceList",
    "Estimate": "geogridapi:Estimate",
    "points_at_sea": {
      "@id": "geogridapi:points_at_sea",
      "@type": "xsd:integer"
    },
    "exact": {
      "@id": "geogridapi:exact",
      "@type": "xsd:boolean"
    },
    "credits": {
      "@id": "geogridapi:credits",
      "@type": "xsd:integer"
    },
    "balance": {
      "@id": "geogridapi:balance",
      "@type": "xsd:integer"
    },
    "balance_after": {
      "@id": "geogridapi:balance_after",
      "@type": "xsd:integer"
    },
    "enough": {
      "@id": "geogridapi:enough",
      "@type": "xsd:boolean"
    },
    "HistoryEntry": "geogridapi:HistoryEntry",
    "History": "geogridapi:History",
    "reference_grid_id": {
      "@id": "geogridapi:reference_grid_id",
      "@type": "xsd:string"
    },
    "change": {
      "@id": "geogridapi:change"
    },
    "Balance": "geogridapi:Balance",
    "BatchItem": "geogridapi:BatchItem",
    "index": {
      "@id": "geogridapi:index",
      "@type": "xsd:integer"
    },
    "Batch": "geogridapi:Batch",
    "items_count": {
      "@id": "geogridapi:items_count",
      "@type": "xsd:integer"
    },
    "counts": {
      "@id": "geogridapi:counts"
    },
    "credits_estimated": {
      "@id": "geogridapi:credits_estimated",
      "@type": "xsd:integer"
    },
    "credits_charged": {
      "@id": "geogridapi:credits_charged",
      "@type": "xsd:integer"
    },
    "items": {
      "@id": "geogridapi:items",
      "@container": "@list"
    },
    "launched_at": {
      "@id": "geogridapi:launched_at",
      "@type": "xsd:dateTime"
    },
    "CreateScheduleRequest": "geogridapi:CreateScheduleRequest",
    "frequency": {
      "@id": "geogridapi:frequency",
      "@type": "xsd:string"
    },
    "weekday": {
      "@id": "geogridapi:weekday",
      "@type": "xsd:integer"
    },
    "month_day": {
      "@id": "geogridapi:month_day",
      "@type": "xsd:integer"
    },
    "Schedule": "geogridapi:Schedule",
    "stopped_reason": {
      "@id": "geogridapi:stopped_reason",
      "@type": "xsd:string"
    },
    "points_per_run": {
      "@id": "geogridapi:points_per_run",
      "@type": "xsd:integer"
    },
    "credits_per_month": {
      "@id": "geogridapi:credits_per_month",
      "@type": "xsd:integer"
    },
    "next_run_at": {
      "@id": "geogridapi:next_run_at",
      "@type": "xsd:dateTime"
    },
    "last_run_at": {
      "@id": "geogridapi:last_run_at",
      "@type": "xsd:dateTime"
    },
    "last_grid_id": {
      "@id": "geogridapi:last_grid_id",
      "@type": "xsd:string"
    },
    "source_grid_id": {
      "@id": "geogridapi:source_grid_id",
      "@type": "xsd:string"
    },
    "runs_count": {
      "@id": "geogridapi:runs_count",
      "@type": "xsd:integer"
    },
    "GridError": "geogridapi:GridError",
    "code": {
      "@id": "geogridapi:code",
      "@type": "xsd:string"
    },
    "message": {
      "@id": "geogridapi:message",
      "@type": "xsd:string"
    },
    "PlaceRef": "geogridapi:PlaceRef"
  },
  "@type": "schema:Dataset",
  "schema:name": "GeoGridAPI API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects GeoGridAPI's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-11-09) from openapi/geogridapi-io-openapi.json.",
  "dcterms:created": "2026-11-09",
  "dcterms:source": [
    "openapi/geogridapi-io-openapi.json"
  ]
}