PredictionService.openapi.json

{"components":{"schemas":{"Error":{"description":"Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize.","properties":{"message":{"description":"Error message (e.g., 'user not found', 'database connection failed')","type":"string"}},"type":"object"},"FieldViolation":{"description":"FieldViolation describes a single validation error for a specific field.","properties":{"description":{"description":"Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing')","type":"string"},"field":{"description":"The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key')","type":"string"}},"required":["field","description"],"type":"object"},"ListPredictionMarketsRequest":{"description":"ListPredictionMarketsRequest specifies filters for retrieving prediction markets.","properties":{"category":{"description":"Optional category filter (e.g., \"Politics\").","type":"string"},"cursor":{"description":"Cursor for next page.","type":"string"},"pageSize":{"description":"Maximum items per page (1-100).","format":"int32","type":"integer"},"query":{"description":"Optional search query for market titles.","type":"string"}},"type":"object"},"ListPredictionMarketsResponse":{"description":"ListPredictionMarketsResponse contains prediction markets matching the request.","properties":{"markets":{"items":{"$ref":"#/components/schemas/PredictionMarket"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"type":"object"},"PaginationResponse":{"description":"PaginationResponse contains pagination metadata returned alongside list results.","properties":{"nextCursor":{"description":"Cursor for fetching the next page. Empty string indicates no more pages.","type":"string"},"totalCount":{"description":"Total count of items matching the query, if known. Zero if the total is unknown.","format":"int32","type":"integer"}},"type":"object"},"PredictionMarket":{"description":"PredictionMarket represents a prediction market contract.","properties":{"category":{"description":"Market category (e.g., \"Politics\", \"Crypto\", \"Sports\").","type":"string"},"closesAt":{"description":"Market close time, as Unix epoch milliseconds. Zero if no expiry.. Warning: Values \u003e 2^53 may lose precision in JavaScript","format":"int64","type":"integer"},"id":{"description":"Unique market identifier or slug.","minLength":1,"type":"string"},"source":{"description":"Source platform for prediction market data.","enum":["MARKET_SOURCE_UNSPECIFIED","MARKET_SOURCE_POLYMARKET","MARKET_SOURCE_KALSHI"],"type":"string"},"title":{"description":"Market question or title.","type":"string"},"url":{"description":"URL to the market page.","type":"string"},"volume":{"description":"Trading volume in USD.","format":"double","minimum":0,"type":"number"},"yesPrice":{"description":"Current \"Yes\" price (0.0 to 1.0, representing probability).","format":"double","maximum":1,"minimum":0,"type":"number"}},"required":["id"],"type":"object"},"ValidationError":{"description":"ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong.","properties":{"violations":{"description":"List of validation violations","items":{"$ref":"#/components/schemas/FieldViolation"},"type":"array"}},"required":["violations"],"type":"object"}}},"info":{"title":"PredictionService API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/prediction/v1/list-prediction-markets":{"get":{"description":"ListPredictionMarkets retrieves active prediction markets from Polymarket.","operationId":"ListPredictionMarkets","parameters":[{"description":"Maximum items per page (1-100).","in":"query","name":"page_size","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"Cursor for next page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Optional category filter (e.g., \"Politics\").","in":"query","name":"category","required":false,"schema":{"type":"string"}},{"description":"Optional search query for market titles.","in":"query","name":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPredictionMarketsResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error response"}},"summary":"ListPredictionMarkets","tags":["PredictionService"]}}}}