openapi.json

{"openapi": "3.1.0", "info": {"title": "FastAPI", "version": "0.1.0"}, "paths": {"/collectives/{royalty_token_symbol}/contract-address": {"get": {"tags": ["collectives"], "summary": "Get Contract Address", "operationId": "get_contract_address", "parameters": [{"required": true, "schema": {"type": "string", "title": "Royalty Token Symbol"}, "name": "royalty_token_symbol", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "string", "title": "Response Collectives-Get Contract Address"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/collectives/{royalty_token_symbol}/proposals": {"get": {"tags": ["collectives"], "summary": "Fetch Proposals", "operationId": "fetch_proposals", "parameters": [{"required": true, "schema": {"type": "string", "title": "Royalty Token Symbol"}, "name": "royalty_token_symbol", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/ProposalInfo"}, "type": "array", "title": "Response Collectives-Fetch Proposals"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/collectives/{royalty_token_symbol}/proposals/{proposal_id}": {"get": {"tags": ["collectives"], "summary": "Get Proposal", "operationId": "get_proposal", "parameters": [{"required": true, "schema": {"type": "string", "title": "Royalty Token Symbol"}, "name": "royalty_token_symbol", "in": "path"}, {"required": true, "schema": {"type": "string", "title": "Proposal Id"}, "name": "proposal_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Proposal"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/initial-royalty-offerings/{royalty_token_symbol}/contract-address": {"get": {"tags": ["initial-royalty-offerings"], "summary": "Get Contract Address", "operationId": "get_contract_address", "parameters": [{"required": true, "schema": {"type": "string", "title": "Royalty Token Symbol"}, "name": "royalty_token_symbol", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "string", "title": "Response Initial-Royalty-Offerings-Get Contract Address"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/initial-royalty-offerings/live": {"get": {"tags": ["initial-royalty-offerings"], "summary": "Fetch Live", "operationId": "fetch_live", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/PrivateRoyaltyToken"}, "type": "array", "title": "Response Initial-Royalty-Offerings-Fetch Live"}}}}}}}, "/initial-royalty-offerings/upcoming": {"get": {"tags": ["initial-royalty-offerings"], "summary": "Fetch Upcoming", "operationId": "fetch_upcoming", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/PrivateRoyaltyToken"}, "type": "array", "title": "Response Initial-Royalty-Offerings-Fetch Upcoming"}}}}}}}, "/royalty-tokens/{symbol}/contract-address": {"get": {"tags": ["royalty-tokens"], "summary": "Get Contract Address", "operationId": "get_contract_address", "parameters": [{"required": true, "schema": {"type": "string", "title": "Symbol"}, "name": "symbol", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "string", "title": "Response Royalty-Tokens-Get Contract Address"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/royalty-tokens/public": {"get": {"tags": ["royalty-tokens"], "summary": "Fetch Public", "operationId": "fetch_public", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/PublicRoyaltyToken"}, "type": "array", "title": "Response Royalty-Tokens-Fetch Public"}}}}}}}, "/royalty-tokens/private": {"get": {"tags": ["royalty-tokens"], "summary": "Fetch Private", "operationId": "fetch_private", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/PrivateRoyaltyToken"}, "type": "array", "title": "Response Royalty-Tokens-Fetch Private"}}}}}}}, "/otc-markets/{royalty_token_symbol}/contract-address": {"get": {"tags": ["otc-markets"], "summary": "Get Contract Address", "operationId": "get_contract_address", "parameters": [{"required": true, "schema": {"type": "string", "title": "Royalty Token Symbol"}, "name": "royalty_token_symbol", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "string", "title": "Response Otc-Markets-Get Contract Address"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/otc-markets/{royalty_token_symbol}/floor-price": {"get": {"tags": ["otc-markets"], "summary": "Get Floor Price", "operationId": "get_floor_price", "parameters": [{"required": true, "schema": {"type": "string", "title": "Royalty Token Symbol"}, "name": "royalty_token_symbol", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BaseValueIndicator"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/otc-markets/{royalty_token_symbol}/trading-volume": {"get": {"tags": ["otc-markets"], "summary": "Get Trading Volume", "operationId": "get_trading_volume", "parameters": [{"required": true, "schema": {"type": "string", "title": "Royalty Token Symbol"}, "name": "royalty_token_symbol", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BaseValueIndicator"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/otc-markets/{royalty_token_symbol}/offers": {"get": {"tags": ["otc-markets"], "summary": "Fetch Offers", "operationId": "fetch_offers", "parameters": [{"required": true, "schema": {"type": "string", "title": "Royalty Token Symbol"}, "name": "royalty_token_symbol", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/Offer"}, "type": "array", "title": "Response Otc-Markets-Fetch Offers"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/portfolios/{stakeholder_address}/estimated-value": {"get": {"tags": ["portfolios"], "summary": "Get Estimated Portfolio Value", "operationId": "get_estimated_portfolio_value", "parameters": [{"required": true, "schema": {"type": "string", "title": "Stakeholder Address"}, "name": "stakeholder_address", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetEstimatedPortfolioValue"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/portfolios/{stakeholder_address}/royalty-income": {"get": {"tags": ["portfolios"], "summary": "Calculate Royalty Income", "operationId": "calculate_royalty_income", "parameters": [{"required": true, "schema": {"type": "string", "title": "Stakeholder Address"}, "name": "stakeholder_address", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetRoyaltyIncomeResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/portfolios/{stakeholder_address}/public-royalty-tokens": {"get": {"tags": ["portfolios"], "summary": "Fetch Public Royalty Tokens", "operationId": "fetch_public_royalty_tokens", "parameters": [{"required": true, "schema": {"type": "string", "title": "Stakeholder Address"}, "name": "stakeholder_address", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/RoyaltyToken"}, "type": "array", "title": "Response Portfolios-Fetch Public Royalty Tokens"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/portfolios/{stakeholder_address}/private-royalty-tokens": {"get": {"tags": ["portfolios"], "summary": "Fetch Private Royalty Tokens", "operationId": "fetch_private_royalty_tokens", "parameters": [{"required": true, "schema": {"type": "string", "title": "Stakeholder Address"}, "name": "stakeholder_address", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/RoyaltyToken"}, "type": "array", "title": "Response Portfolios-Fetch Private Royalty Tokens"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/protocol/trading-volume": {"get": {"tags": ["protocol"], "summary": "Get Trading Volume", "operationId": "get_trading_volume", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetTradingVolume"}}}}}}}, "/protocol/royalty-income": {"get": {"tags": ["protocol"], "summary": "Get Royalty Income Per Protocol", "operationId": "get_royalty_income_per_protocol", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetRoyaltyIncomeResponse"}}}}}}}, "/royalty-exchanges/{royalty_token_symbol}/contract-address": {"get": {"tags": ["royalty-exchanges"], "summary": "Get Contract Address", "operationId": "get_contract_address", "parameters": [{"required": true, "schema": {"type": "string", "title": "Royalty Token Symbol"}, "name": "royalty_token_symbol", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "string", "title": "Response Royalty-Exchanges-Get Contract Address"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/royalty-exchanges/{royalty_token_symbol}/price": {"get": {"tags": ["royalty-exchanges"], "summary": "Get Price", "operationId": "get_price", "parameters": [{"required": true, "schema": {"type": "string", "title": "Royalty Token Symbol"}, "name": "royalty_token_symbol", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BaseValueIndicator"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/royalty-exchanges/{royalty_token_symbol}/trading-volume": {"get": {"tags": ["royalty-exchanges"], "summary": "Get Trading Volume", "operationId": "get_trading_volume", "parameters": [{"required": true, "schema": {"type": "string", "title": "Royalty Token Symbol"}, "name": "royalty_token_symbol", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BaseValueIndicator"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/royalty-payment-pools/{royalty_token_symbol}/contract-address": {"get": {"tags": ["royalty-payment-pools"], "summary": "Get Contract Address", "operationId": "get_contract_address", "parameters": [{"required": true, "schema": {"type": "string", "title": "Royalty Token Symbol"}, "name": "royalty_token_symbol", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "string", "title": "Response Royalty-Payment-Pools-Get Contract Address"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/royalty-payment-pools/{royalty_token_symbol}/royalty-income": {"get": {"tags": ["royalty-payment-pools"], "summary": "Get Royalty Income", "operationId": "get_royalty_income", "parameters": [{"required": true, "schema": {"type": "string", "title": "Royalty Token Symbol"}, "name": "royalty_token_symbol", "in": "path"}, {"required": false, "schema": {"type": "string", "format": "date-time", "title": "Upper Bound", "default": "2023-12-01T12:55:58.389170"}, "name": "upper_bound", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GetRoyaltyIncomeResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/royalty-payment-pools/{royalty_token_symbol}/deposits": {"get": {"tags": ["royalty-payment-pools"], "summary": "Fetch Deposits", "operationId": "fetch_deposits", "parameters": [{"required": true, "schema": {"type": "string", "title": "Royalty Token Symbol"}, "name": "royalty_token_symbol", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/Deposit"}, "type": "array", "title": "Response Royalty-Payment-Pools-Fetch Deposits"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}}, "components": {"schemas": {"BaseValueIndicator": {"properties": {"current": {"$ref": "#/components/schemas/TimeSeriesDataPoint"}, "recentValuesDataset": {"items": {"$ref": "#/components/schemas/TimeSeriesDataPoint"}, "type": "array", "title": "Recentvaluesdataset"}}, "type": "object", "required": ["current", "recentValuesDataset"], "title": "BaseValueIndicator"}, "Deposit": {"properties": {"distributor": {"type": "string", "title": "Distributor"}, "checkpointKey": {"type": "integer", "title": "Checkpointkey"}, "amount": {"type": "integer", "title": "Amount"}}, "type": "object", "required": ["distributor", "checkpointKey", "amount"], "title": "Deposit"}, "GetEstimatedPortfolioValue": {"properties": {"onOtcMarket": {"$ref": "#/components/schemas/BaseValueIndicator"}, "atRoyaltyExchange": {"$ref": "#/components/schemas/BaseValueIndicator"}}, "type": "object", "required": ["onOtcMarket", "atRoyaltyExchange"], "title": "GetEstimatedPortfolioValue"}, "GetRoyaltyIncomeResponse": {"properties": {"reported": {"$ref": "#/components/schemas/BaseValueIndicator"}, "deposited": {"$ref": "#/components/schemas/BaseValueIndicator"}}, "type": "object", "required": ["reported", "deposited"], "title": "GetRoyaltyIncomeResponse"}, "GetTradingVolume": {"properties": {"otcMarket": {"$ref": "#/components/schemas/BaseValueIndicator"}, "royaltyExchange": {"$ref": "#/components/schemas/BaseValueIndicator"}}, "type": "object", "required": ["otcMarket", "royaltyExchange"], "title": "GetTradingVolume"}, "HTTPValidationError": {"properties": {"detail": {"items": {"$ref": "#/components/schemas/ValidationError"}, "type": "array", "title": "Detail"}}, "type": "object", "title": "HTTPValidationError"}, "Offer": {"properties": {"offerId": {"type": "string", "title": "Offerid"}, "seller": {"type": "string", "title": "Seller"}, "royaltyTokenAmount": {"type": "string", "title": "Royaltytokenamount"}, "stablecoinAmount": {"type": "string", "title": "Stablecoinamount"}}, "type": "object", "required": ["offerId", "seller", "royaltyTokenAmount", "stablecoinAmount"], "title": "Offer"}, "PrivateRoyaltyToken": {"properties": {"symbol": {"type": "string", "title": "Symbol"}, "depositedRoyaltyIncome": {"$ref": "#/components/schemas/BaseValueIndicator"}}, "type": "object", "required": ["symbol", "depositedRoyaltyIncome"], "title": "PrivateRoyaltyToken"}, "Proposal": {"properties": {"info": {"$ref": "#/components/schemas/ProposalInfo"}, "description": {"$ref": "#/components/schemas/ProposalDescription"}}, "type": "object", "required": ["info", "description"], "title": "Proposal"}, "ProposalDescription": {"properties": {"description": {"type": "string", "title": "Description"}, "targets": {"items": {"type": "string"}, "type": "array", "title": "Targets"}, "values": {"items": {"type": "integer"}, "type": "array", "title": "Values"}, "signatures": {"items": {"type": "string"}, "type": "array", "title": "Signatures"}, "calldatas": {"items": {"type": "string"}, "type": "array", "title": "Calldatas"}}, "type": "object", "required": ["description", "targets", "values", "signatures", "calldatas"], "title": "ProposalDescription"}, "ProposalInfo": {"properties": {"proposalId": {"type": "string", "title": "Proposalid"}, "proposer": {"type": "string", "title": "Proposer"}, "title": {"type": "string", "title": "Title"}, "votes": {"$ref": "#/components/schemas/ProposalVotes"}, "isExecuted": {"type": "boolean", "title": "Isexecuted"}}, "type": "object", "required": ["proposalId", "proposer", "title", "votes", "isExecuted"], "title": "ProposalInfo"}, "ProposalVotes": {"properties": {"pro": {"type": "integer", "title": "Pro"}, "contra": {"type": "integer", "title": "Contra"}, "abstain": {"type": "integer", "title": "Abstain"}}, "type": "object", "required": ["pro", "contra", "abstain"], "title": "ProposalVotes"}, "PublicRoyaltyToken": {"properties": {"symbol": {"type": "string", "title": "Symbol"}, "depositedRoyaltyIncome": {"$ref": "#/components/schemas/BaseValueIndicator"}, "price": {"$ref": "#/components/schemas/BaseValueIndicator"}}, "type": "object", "required": ["symbol", "depositedRoyaltyIncome", "price"], "title": "PublicRoyaltyToken"}, "RoyaltyToken": {"properties": {"symbol": {"type": "string", "title": "Symbol"}}, "type": "object", "required": ["symbol"], "title": "RoyaltyToken"}, "TimeSeriesDataPoint": {"properties": {"timestamp": {"type": "number", "title": "Timestamp"}, "value": {"type": "string", "title": "Value"}}, "type": "object", "required": ["timestamp", "value"], "title": "TimeSeriesDataPoint"}, "ValidationError": {"properties": {"loc": {"items": {"anyOf": [{"type": "string"}, {"type": "integer"}]}, "type": "array", "title": "Location"}, "msg": {"type": "string", "title": "Message"}, "type": {"type": "string", "title": "Error Type"}}, "type": "object", "required": ["loc", "msg", "type"], "title": "ValidationError"}}}}