{ "openapi": "3.1.1", "info": { "title": "WolfMarket.Api | v1", "version": "1.0.0" }, "servers": [ { "url": "https://wolfmarketai.com/" } ], "paths": { "/api/command/health": { "get": { "tags": [ "WolfMarket.Api" ], "responses": { "200": { "description": "OK" } } } }, "/api/command/metrics": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "windowMinutes", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/command/errors": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "windowMinutes", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/subscriptions": { "post": { "tags": [ "WolfMarket.Api" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/subscriptions/{id}": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/catalog/sources": { "get": { "tags": [ "WolfMarket.Api" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/catalog/datasets": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "source", "in": "query", "schema": { "type": "string" } }, { "name": "domain", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/catalog/series": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "dataset", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/series/{seriesKey}/observations": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "seriesKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "asOf", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/cot/markets": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/cot/legacy": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "market", "in": "query", "schema": { "type": "string" } }, { "name": "variant", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "asOf", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/cot/disaggregated": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "market", "in": "query", "schema": { "type": "string" } }, { "name": "variant", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "asOf", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/cot/tff": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "market", "in": "query", "schema": { "type": "string" } }, { "name": "variant", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "asOf", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/companies": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "covered", "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/global/companies": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "registry", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/global/companies/{registry}/{number}": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "registry", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "number", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/companies/{cikOrTicker}": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "cikOrTicker", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/filings": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "cik", "in": "query", "schema": { "type": "string" } }, { "name": "ticker", "in": "query", "schema": { "type": "string" } }, { "name": "form", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/facts": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "cik", "in": "query", "schema": { "type": "string" } }, { "name": "ticker", "in": "query", "schema": { "type": "string" } }, { "name": "tag", "in": "query", "schema": { "type": "string" } }, { "name": "taxonomy", "in": "query", "schema": { "type": "string" } }, { "name": "unit", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/filings/{accessionNumber}": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "accessionNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/register": { "post": { "tags": [ "WolfMarket.Api" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/portal/login": { "post": { "tags": [ "WolfMarket.Api" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/portal/logout": { "post": { "tags": [ "WolfMarket.Api" ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/me": { "get": { "tags": [ "WolfMarket.Api" ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/keys": { "get": { "tags": [ "WolfMarket.Api" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "WolfMarket.Api" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/portal/keys/{id}/revoke": { "post": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/bundles": { "get": { "tags": [ "WolfMarket.Api" ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/subscriptions": { "get": { "tags": [ "WolfMarket.Api" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "WolfMarket.Api" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/portal/alerts": { "get": { "tags": [ "WolfMarket.Api" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "WolfMarket.Api" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertPrefsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/portal/usage": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/dashboard/overview": { "get": { "tags": [ "WolfMarket.Api" ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/dashboard/series": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "key", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/dashboard/series-search": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/dashboard/company/{cik}": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "cik", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/dashboard/company/{cik}/facts": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "cik", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "tag", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/dashboard/cot": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "market", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/dashboard/bundle/{code}": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/billing": { "get": { "tags": [ "WolfMarket.Api" ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/billing/checkout": { "post": { "tags": [ "WolfMarket.Api" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/portal/billing/manage": { "post": { "tags": [ "WolfMarket.Api" ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/admin/accounts": { "get": { "tags": [ "WolfMarket.Api" ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/admin/usage": { "get": { "tags": [ "WolfMarket.Api" ], "parameters": [ { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/portal/admin/review": { "get": { "tags": [ "WolfMarket.Api" ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AlertPrefsRequest": { "required": [ "filingAlerts", "weeklyDigest" ], "type": "object", "properties": { "filingAlerts": { "type": "boolean" }, "weeklyDigest": { "type": "boolean" } } }, "CheckoutRequest": { "required": [ "planCode" ], "type": "object", "properties": { "planCode": { "type": "string" } } }, "CreateKeyRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } } }, "LoginRequest": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } } }, "PortalSubscriptionRequest": { "required": [ "targetType", "targetKey", "apiKeyId" ], "type": "object", "properties": { "targetType": { "type": "string" }, "targetKey": { "type": "string" }, "apiKeyId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "RegisterRequest": { "required": [ "email", "password", "companyName", "invite" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "companyName": { "type": [ "null", "string" ] }, "invite": { "type": [ "null", "string" ] } } }, "SubscriptionRequest": { "required": [ "targetType", "targetKey" ], "type": "object", "properties": { "targetType": { "type": "string" }, "targetKey": { "type": "string" } } } } }, "tags": [ { "name": "WolfMarket.Api" } ] }