{ "openapi": "3.1.0", "info": { "title": "BrytaLocals API", "version": "1.0.0", "description": "Shared first-party API for web, iOS and Android. Public facts retain source periods. Private research remains unlisted. Native authentication uses an explicit browser handoff with S256 PKCE; never embed database or Google web-client secrets in an app." }, "servers": [ { "url": "https://brytalocals.com" }, { "url": "http://127.0.0.1:3000", "description": "Local development" } ], "paths": { "/api/v1/version": { "get": { "summary": "Active evidence release and coverage", "operationId": "get__api_v1_version", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/communities": { "get": { "summary": "National USGS GNIS named locations, without implied neighborhood boundaries or assigned population statistics", "operationId": "get__api_v1_communities", "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "release", "schema": { "type": "string" } }, { "in": "query", "name": "q", "schema": { "type": "string" } }, { "in": "query", "name": "state", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$" } }, { "in": "query", "name": "county", "schema": { "type": "string", "pattern": "^[0-9]{5}$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/communities/{id}": { "get": { "summary": "USGS name, source coordinate, record dates and original-source link", "operationId": "get__api_v1_communities_id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,10}$" } }, { "in": "query", "name": "release", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/local-areas": { "get": { "summary": "National Census tracts; geometry and composition omitted from collections; nearby distances use representative points", "operationId": "get__api_v1_local_areas", "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "release", "schema": { "type": "string" } }, { "in": "query", "name": "state", "schema": { "type": "string", "pattern": "^[0-9]{2}$" } }, { "in": "query", "name": "county", "schema": { "type": "string", "pattern": "^[0-9]{5}$" } }, { "in": "query", "name": "near", "schema": { "type": "string", "pattern": "^[0-9]{7}$" } }, { "in": "query", "name": "radius", "schema": { "type": "number", "exclusiveMinimum": 0, "maximum": 25 } }, { "in": "query", "name": "q", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/local-areas/{id}": { "get": { "summary": "Census tract, ACS observations and 90% margins, demographic proportions, source period and generalized boundary", "operationId": "get__api_v1_local_areas_id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{11}$" } }, { "in": "query", "name": "release", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/neighborhoods": { "get": { "summary": "City-published named local areas; definitions retained and geometry omitted from collections", "operationId": "get__api_v1_neighborhoods", "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "release", "schema": { "type": "string" } }, { "in": "query", "name": "parent", "schema": { "type": "string" } }, { "in": "query", "name": "q", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LocalArea" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/neighborhoods/{id}": { "get": { "summary": "Local area boundary, geographic definition and available evidence", "operationId": "get__api_v1_neighborhoods_id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "release", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LocalArea" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/facilities": { "get": { "summary": "Dated public-library buildings near coordinates; straight-line miles", "operationId": "get__api_v1_facilities", "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "release", "schema": { "type": "string" } }, { "in": "query", "name": "lat", "schema": { "type": "number", "minimum": -90, "maximum": 90 } }, { "in": "query", "name": "lon", "schema": { "type": "number", "minimum": -180, "maximum": 180 } }, { "in": "query", "name": "radius", "schema": { "type": "number", "exclusiveMinimum": 0, "maximum": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Facility" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/facilities/{id}": { "get": { "summary": "IMLS public-library outlet and provenance", "operationId": "get__api_v1_facilities_id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "release", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Facility" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/changes": { "get": { "summary": "Observation additions and revisions, with prior and current source periods", "operationId": "get__api_v1_changes", "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "release", "schema": { "type": "string" } }, { "in": "query", "name": "entity", "schema": { "enum": [ "place", "school", "neighborhood", "tract", "community" ] } }, { "in": "query", "name": "entityId", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EvidenceChange" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/places": { "get": { "summary": "Search published US places", "operationId": "get__api_v1_places", "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "release", "schema": { "type": "string" } }, { "in": "query", "name": "q", "schema": { "type": "string" } }, { "in": "query", "name": "state", "schema": { "type": "string" } }, { "in": "query", "name": "sort", "schema": { "enum": [ "name", "population", "home", "rent", "distance" ] } }, { "in": "query", "name": "lat", "schema": { "type": "number", "minimum": -90, "maximum": 90 } }, { "in": "query", "name": "lon", "schema": { "type": "number", "minimum": -180, "maximum": 180 } }, { "in": "query", "name": "radius", "schema": { "type": "number", "exclusiveMinimum": 0, "maximum": 250 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Place" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/places/{id}": { "get": { "summary": "A place and its source-backed observations", "operationId": "get__api_v1_places_id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "release", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Place" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/schools": { "get": { "summary": "Search schools", "operationId": "get__api_v1_schools", "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "release", "schema": { "type": "string" } }, { "in": "query", "name": "q", "schema": { "type": "string" } }, { "in": "query", "name": "state", "schema": { "type": "string" } }, { "in": "query", "name": "zip", "schema": { "type": "string" } }, { "in": "query", "name": "outcomes", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/School" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/schools/{id}": { "get": { "summary": "Read schools record", "operationId": "get__api_v1_schools_id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "release", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/School" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/regions": { "get": { "summary": "Search regions", "operationId": "get__api_v1_regions", "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "release", "schema": { "type": "string" } }, { "in": "query", "name": "kind", "schema": { "enum": [ "state", "metro" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Region" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/regions/{id}": { "get": { "summary": "Read regions record", "operationId": "get__api_v1_regions_id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "release", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Region" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/metrics": { "get": { "summary": "Metric definitions", "operationId": "get__api_v1_metrics", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Metric" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/metrics/{id}": { "get": { "summary": "Metric definition", "operationId": "get__api_v1_metrics_id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Metric" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/sources": { "get": { "summary": "Known source release checks", "operationId": "get__api_v1_sources", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/news": { "get": { "summary": "Attributed publisher reporting and cache freshness", "operationId": "get__api_v1_news", "parameters": [ { "in": "query", "name": "place", "schema": { "type": "string" } }, { "in": "query", "name": "days", "schema": { "enum": [ 1, 7, 30, 90 ] } }, { "in": "query", "name": "scope", "schema": { "enum": [ "place", "state" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/comparisons/{id}": { "get": { "summary": "Unlisted permanent comparison", "operationId": "get__api_v1_comparisons_id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Comparison" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/api/v1/comparisons": { "post": { "summary": "Create an unlisted link; save=true requires an account", "operationId": "post__api_v1_comparisons", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comparison" } } } }, "security": [] } }, "/api/v1/auth/requests": { "post": { "summary": "Start a native browser authorization handoff", "operationId": "post__api_v1_auth_requests", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "authorizationUrl": { "type": "string" }, "expiresIn": { "const": 600 } } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NativeRequest" } } } }, "security": [] } }, "/api/v1/auth/token": { "post": { "summary": "Exchange a one-use code or rotate refresh token", "operationId": "post__api_v1_auth_token", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Tokens" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NativeTokenRequest" } } } }, "security": [] } }, "/api/v1/auth/authorize": { "post": { "summary": "Explicit browser consent; same-origin cookie required", "operationId": "post__api_v1_auth_authorize", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "redirect": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "type": "string" } }, "required": [ "request" ] } } } }, "security": [ { "BrowserCookie": [] } ] } }, "/api/v1/me": { "get": { "summary": "Current account", "operationId": "get__api_v1_me", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "MobileBearer": [] }, { "BrowserCookie": [] } ] } }, "/api/v1/me/data": { "post": { "summary": "Export private account data or request and confirm deletion", "operationId": "post__api_v1_me_data", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "action": { "const": "export" } }, "required": [ "action" ] }, { "type": "object", "properties": { "action": { "const": "request-deletion" } }, "required": [ "action" ] }, { "type": "object", "properties": { "action": { "const": "delete" }, "token": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "confirmation": { "const": "DELETE" } }, "required": [ "action", "token", "confirmation" ] } ] } } } }, "security": [ { "MobileBearer": [] }, { "BrowserCookie": [] } ] } }, "/api/v1/me/searches": { "get": { "summary": "Owned searches", "operationId": "get__api_v1_me_searches", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "MobileBearer": [] }, { "BrowserCookie": [] } ] }, "post": { "summary": "Save an owned search", "operationId": "post__api_v1_me_searches", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 120 }, "query": { "type": "string" } }, "required": [ "name", "query" ] } } } }, "security": [ { "MobileBearer": [] }, { "BrowserCookie": [] } ] }, "delete": { "summary": "Remove an owned searches entry", "operationId": "delete__api_v1_me_searches", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "security": [ { "MobileBearer": [] }, { "BrowserCookie": [] } ] } }, "/api/v1/me/preferences": { "get": { "summary": "Owned preferences", "operationId": "get__api_v1_me_preferences", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "MobileBearer": [] }, { "BrowserCookie": [] } ] }, "put": { "summary": "Save account defaults", "operationId": "put__api_v1_me_preferences", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metrics": { "type": "array", "items": { "type": "string" } }, "topics": { "type": "array", "items": { "type": "string" } } }, "required": [ "metrics", "topics" ] } } } }, "security": [ { "MobileBearer": [] }, { "BrowserCookie": [] } ] } }, "/api/v1/me/comparisons": { "get": { "summary": "Owned comparisons", "operationId": "get__api_v1_me_comparisons", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "MobileBearer": [] }, { "BrowserCookie": [] } ] }, "delete": { "summary": "Remove an owned comparisons entry", "operationId": "delete__api_v1_me_comparisons", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "security": [ { "MobileBearer": [] }, { "BrowserCookie": [] } ] } }, "/api/v1/me/followings": { "get": { "summary": "Owned followings", "operationId": "get__api_v1_me_followings", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "MobileBearer": [] }, { "BrowserCookie": [] } ] } }, "/api/v1/me/devices": { "get": { "summary": "Owned devices", "operationId": "get__api_v1_me_devices", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "MobileBearer": [] }, { "BrowserCookie": [] } ] }, "delete": { "summary": "Remove an owned devices entry", "operationId": "delete__api_v1_me_devices", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "security": [ { "MobileBearer": [] }, { "BrowserCookie": [] } ] } }, "/api/v1/newsletter": { "get": { "summary": "Subscription for a verified signed-in email", "operationId": "get__api_v1_newsletter", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] }, "post": { "summary": "Explicit newsletter consent and private preference actions", "operationId": "post__api_v1_newsletter", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Newsletter" } } } }, "security": [] } }, "/api/v1/reports": { "post": { "summary": "Report a place or metric issue", "operationId": "post__api_v1_reports", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data", "meta" ] } } } }, "304": { "description": "ETag matched; no response body" }, "400": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Dataset changed or action conflicts. Restart pagination on dataset_changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Request rejected or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "placeId": { "type": "string" }, "metric": { "type": "string" }, "reason": { "type": "string" }, "details": { "type": "string", "minLength": 10, "maxLength": 2000 }, "sourceUrl": { "type": "string" }, "context": { "type": "string" } }, "required": [ "id", "placeId", "metric", "reason", "details" ] } } } }, "security": [ { "MobileBearer": [] }, { "BrowserCookie": [] } ] } } }, "components": { "schemas": { "Meta": { "type": "object", "properties": { "apiVersion": { "const": "1" }, "release": { "type": "string" }, "period": { "type": "string" }, "schoolYear": { "type": "string" }, "publishedAt": { "type": "string", "format": "date-time" }, "nextCursor": { "type": [ "string", "null" ] } }, "required": [ "apiVersion" ] }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "error", "meta" ] }, "Observation": { "type": "object", "properties": { "metric": { "type": "string" }, "value": { "type": [ "number", "null" ] }, "marginOfError": { "type": [ "number", "null" ] }, "status": { "type": "string" }, "period": { "type": [ "string", "null" ] }, "unit": { "type": [ "string", "null" ] }, "sourceUrl": { "type": [ "string", "null" ] }, "denominator": { "type": [ "number", "null" ] }, "reportedMonths": { "type": [ "number", "null" ] } }, "required": [ "metric", "value", "status", "period" ] }, "Place": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "state": { "type": "string" }, "stateId": { "type": "string" }, "kind": { "type": "string" }, "lat": { "type": "number" }, "lon": { "type": "number" }, "home": { "type": "array" }, "rent": { "type": "array" }, "income": { "type": "array" }, "population": { "type": "array" }, "community": { "type": "object" }, "crime": { "type": [ "object", "null" ] }, "observations": { "type": "array", "items": { "$ref": "#/components/schemas/Observation" } } }, "required": [ "id", "name", "state", "lat", "lon" ] }, "School": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "grades": { "type": "array", "items": { "type": "string" } }, "lat": { "type": [ "number", "null" ], "description": "Null for preliminary identities without a published NCES location." }, "lon": { "type": [ "number", "null" ] }, "hasOutcomes": { "type": "boolean" }, "outcomes": { "type": [ "object", "null" ], "description": "School year, source URL and cohorts with original status, denominators, suppression and within-state ranks. Missing subject keys mean unavailable, never zero." } }, "required": [ "id", "name", "state" ] }, "Metric": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "topic": { "type": "string" }, "description": { "type": "string" }, "sourceType": { "type": "string" }, "period": { "type": [ "string", "null" ] }, "unit": { "type": [ "string", "null" ] }, "table": { "type": "string" } }, "required": [ "id", "label", "description", "sourceType" ] }, "Region": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "enum": [ "state", "metro" ] }, "code": { "type": "string" }, "states": { "type": "array", "items": { "type": "string" } }, "home": { "type": "array" }, "rent": { "type": "array" }, "income": { "type": "array" }, "population": { "type": "array" } }, "required": [ "id", "name", "kind" ] }, "LocalArea": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "parentPlaceId": { "type": "string" }, "kind": { "type": "string" }, "kindLabel": { "type": "string" }, "lat": { "type": "number" }, "lon": { "type": "number" }, "bbox": { "type": "array", "minItems": 4, "maxItems": 4, "items": { "type": "number" } }, "geometry": { "type": "object", "description": "GeoJSON Polygon or MultiPolygon. Present on the single-record endpoint only." }, "period": { "type": [ "string", "null" ] }, "releaseLabel": { "type": "string" }, "sourceUrl": { "type": "string" }, "boundarySourceUrl": { "type": "string" }, "method": { "type": "string" }, "geometryNote": { "type": "string" }, "facts": { "type": "object", "additionalProperties": { "type": "object", "properties": { "value": { "type": [ "number", "null" ] }, "moe": { "type": [ "number", "null" ] }, "uncertaintyStatus": { "type": "string" } }, "required": [ "value", "moe", "uncertaintyStatus" ] }, "description": "Area-specific observations only. An empty object means not connected, never city-level substitutes." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "number" }, "percent": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "id", "label", "count", "percent" ] } } }, "required": [ "id", "slug", "name", "city", "state", "kind", "kindLabel", "parentPlaceId", "period", "sourceUrl", "boundarySourceUrl", "facts" ] }, "Facility": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "postalCity": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "lat": { "type": "number" }, "lon": { "type": "number" }, "type": { "type": "string" }, "period": { "type": "string" }, "sourceUrl": { "type": "string" }, "geocodeMethod": { "type": "string" }, "straightLineMiles": { "type": "number", "minimum": 0, "description": "Distance from supplied query coordinates; collection endpoint only. Not road or travel distance." } }, "required": [ "id", "name", "state", "lat", "lon", "type", "period", "sourceUrl" ] }, "EvidenceChange": { "type": "object", "properties": { "id": { "type": "integer" }, "release_id": { "type": "string" }, "previous_release_id": { "type": [ "string", "null" ] }, "entity_type": { "enum": [ "place", "school", "neighborhood", "tract", "community" ] }, "entity_id": { "type": "string" }, "metric": { "type": "string" }, "kind": { "enum": [ "added", "updated", "removed", "definition_changed" ] }, "old_observation": { "type": [ "object", "null" ] }, "new_observation": { "type": [ "object", "null" ] }, "published_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "release_id", "entity_type", "entity_id", "metric", "kind", "old_observation", "new_observation", "published_at" ] }, "Comparison": { "type": "object", "properties": { "placeIds": { "type": "array", "minItems": 2, "maxItems": 4, "uniqueItems": true, "items": { "type": "string" } }, "metrics": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string" } }, "focusedMetric": { "type": "string", "description": "Optional selected metric; must also appear in metrics. Preserved when reopening a place comparison." }, "save": { "type": "boolean" }, "kind": { "enum": [ "place", "state", "metro", "neighborhood" ], "description": "Neighborhood comparisons require 2–4 supported IDs of the same official geographic type." } }, "required": [ "placeIds", "metrics" ] }, "NativeRequest": { "type": "object", "properties": { "client_id": { "enum": [ "brytalocals-ios", "brytalocals-android" ] }, "redirect_uri": { "enum": [ "com.brytalocals.ios:/oauth/callback", "com.brytalocals.android:/oauth/callback" ] }, "code_challenge": { "type": "string" }, "code_challenge_method": { "const": "S256" }, "state": { "type": "string", "minLength": 16, "maxLength": 128 } }, "required": [ "client_id", "redirect_uri", "code_challenge", "code_challenge_method", "state" ] }, "NativeTokenRequest": { "oneOf": [ { "type": "object", "properties": { "grant_type": { "const": "authorization_code" }, "client_id": { "type": "string" }, "redirect_uri": { "type": "string" }, "code": { "type": "string" }, "code_verifier": { "type": "string", "minLength": 43, "maxLength": 128 }, "device_name": { "type": "string", "maxLength": 80 } }, "required": [ "grant_type", "client_id", "redirect_uri", "code", "code_verifier" ] }, { "type": "object", "properties": { "grant_type": { "const": "refresh_token" }, "client_id": { "type": "string" }, "refresh_token": { "type": "string" } }, "required": [ "grant_type", "client_id", "refresh_token" ] } ] }, "Tokens": { "type": "object", "properties": { "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "tokenType": { "const": "Bearer" }, "expiresIn": { "type": "integer", "const": 900 } }, "required": [ "accessToken", "refreshToken", "tokenType", "expiresIn" ] }, "Newsletter": { "type": "object", "properties": { "action": { "enum": [ "subscribe", "request-link", "confirm", "inspect", "save", "unsubscribe", "sample" ] }, "email": { "type": "string", "format": "email" }, "token": { "type": "string" }, "placeIds": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 20 }, "topics": { "type": "array", "items": { "enum": [ "schools", "housing", "transport", "safety", "community", "laws" ] } }, "frequency": { "enum": [ "weekly", "monthly" ] }, "consent": { "type": "boolean" } }, "required": [ "action" ] } }, "securitySchemes": { "MobileBearer": { "type": "http", "scheme": "bearer", "description": "A bl_access_ token from the native handoff; store in platform secure storage." }, "BrowserCookie": { "type": "apiKey", "in": "cookie", "name": "uslocal_session", "description": "Browser requests require a same-origin Origin header for writes." } } } }