View .mdENIT

OpenAPI 3.1 specification

Guide6 min

The Open API publishes an OpenAPI 3.1 document describing every REST operation it serves, for the tools that generate a client or test calls from one.

Unpublished — this page is visible on staging only and is not on the public site.

Where is the OpenAPI document?

At https://app.fincanva.com/api/v1/research/openapi.json. It is public: reading it needs no credential.

What does the OpenAPI document describe?

  • Every operation the REST API serves, which is more than the Reference documents today.
  • Each operation’s request body, its success response with worked examples, and its error responses.
  • Its version, in info.version: 1.0.0.
  • One security scheme, bearer: an API key or an OAuth 2.1 access token with the fincanva.research scope.

Which page documents each way into Fincanva?

The table lists every operation the Open API and the MCP server serve, then every other address a client or a signed-in user reaches from outside: the MCP server, this document, OAuth sign-in and its discovery documents, and the Settings routes for API keys, connected apps, usage and results. A row with no page says «Not documented yet».

Operation or addressDoorEnglish pageItalian page
list_allocation_methodsMCP + RESTList allocation methodsElenca i metodi di allocazione
list_risk_rule_presetsMCP + RESTList risk condition presetsElenca i preset delle condizioni di rischio
list_screen_filtersMCP + RESTList screener filtersElenca i filtri dello screener
describe_screen_filterMCP + RESTDescribe a screener filterDescrivi un filtro dello screener
describe_strategy_modelMCP + RESTDescribe the strategy modelDescrivi il modello di strategia
list_my_strategiesMCP + RESTNot documented yetNot documented yet
list_my_screenersMCP + RESTNot documented yetNot documented yet
list_my_live_strategiesMCP + RESTNot documented yetNot documented yet
get_my_strategyMCP + RESTNot documented yetNot documented yet
get_my_screenerMCP + RESTNot documented yetNot documented yet
find_assetsMCP + RESTNot documented yetNot documented yet
get_resultMCP + RESTNot documented yetNot documented yet
run_pipelineMCP + RESTNot documented yetNot documented yet
get_data_coverageMCP + RESTNot documented yetNot documented yet
create_screenerMCP + RESTNot documented yetNot documented yet
edit_screenerMCP + RESTNot documented yetNot documented yet
replace_screenerMCP + RESTNot documented yetNot documented yet
validate_screenerMCP + RESTNot documented yetNot documented yet
explain_screenerMCP + RESTNot documented yetNot documented yet
list_covariance_estimatorsMCP + RESTNot documented yetNot documented yet
create_strategyMCP + RESTNot documented yetNot documented yet
edit_strategyMCP + RESTNot documented yetNot documented yet
replace_strategyMCP + RESTNot documented yetNot documented yet
validate_strategyMCP + RESTNot documented yetNot documented yet
explain_strategyMCP + RESTNot documented yetNot documented yet
simulate_strategyMCP + RESTNot documented yetNot documented yet
get_simulation_metricsMCP + RESTNot documented yetNot documented yet
get_simulation_equityMCP + RESTNot documented yetNot documented yet
get_simulation_monthly_returnsMCP + RESTNot documented yetNot documented yet
get_simulation_allocationsMCP + RESTNot documented yetNot documented yet
get_simulation_positionsMCP + RESTNot documented yetNot documented yet
get_simulation_current_stateMCP + RESTNot documented yetNot documented yet
get_strategies_analyticsMCP + RESTNot documented yetNot documented yet
get_simulation_correlationsMCP + RESTNot documented yetNot documented yet
get_rolling_correlationMCP + RESTNot documented yetNot documented yet
get_start_date_sensitivityMCP + RESTNot documented yetNot documented yet
get_contribution_analysisMCP + RESTNot documented yetNot documented yet
get_regime_timelineMCP + RESTNot documented yetNot documented yet
get_projection_coneMCP + RESTNot documented yetNot documented yet
get_backtest_trustMCP + RESTNot documented yetNot documented yet
run_stress_testMCP + RESTNot documented yetNot documented yet
get_rotation_datesMCP + RESTNot documented yetNot documented yet
get_todays_rotationsMCP + RESTNot documented yetNot documented yet
compare_simulationsMCP + RESTNot documented yetNot documented yet
get_research_guideMCP + RESTNot documented yetNot documented yet
POST /mcpMCPThe Fincanva MCP serverIl server MCP di Fincanva
POST /api/v1/research/{operation}RESTThe Fincanva Open APIL’Open API di Fincanva
GET /api/v1/research/openapi.jsonRESTOpenAPI 3.1 specificationSpecifica OpenAPI 3.1
GET /.well-known/oauth-protected-resourceOAuth sign-inAuthentication and API keysAutenticazione e chiavi API
GET /.well-known/oauth-authorization-serverOAuth sign-inAuthentication and API keysAutenticazione e chiavi API
GET /.well-known/research-jwks.jsonOAuth sign-inAuthentication and API keysAutenticazione e chiavi API
GET /api/auth/oauth2/authorizeOAuth sign-inAuthentication and API keysAutenticazione e chiavi API
POST /api/auth/oauth2/consentOAuth sign-inAuthentication and API keysAutenticazione e chiavi API
POST /api/auth/oauth2/tokenOAuth sign-inAuthentication and API keysAutenticazione e chiavi API
POST /api/auth/oauth2/registerOAuth sign-inAuthentication and API keysAutenticazione e chiavi API
POST /api/auth/oauth2/revokeOAuth sign-inAuthentication and API keysAutenticazione e chiavi API
GET, POST /api/research/keysSigned-in settingsAuthentication and API keysAutenticazione e chiavi API
PATCH, DELETE /api/research/keys/{id}Signed-in settingsAuthentication and API keysAutenticazione e chiavi API
GET /api/research/connectionsSigned-in settingsThe Fincanva MCP serverIl server MCP di Fincanva
PATCH, DELETE /api/research/connections/{clientId}Signed-in settingsThe Fincanva MCP serverIl server MCP di Fincanva
GET /api/research/connections/consent-contextSigned-in settingsThe Fincanva MCP serverIl server MCP di Fincanva
GET /api/research/usageSigned-in settingsPlans, quotas and limitsPiani, quote e limiti
GET, PATCH /api/research/results/{recipeId}Signed-in settingsThe result envelopeLa struttura del risultato
POST /api/research/results/{recipeId}/rerunSigned-in settingsThe result envelopeLa struttura del risultato
GET /api/research/open/{kind}/{id}Signed-in settingsThe result envelopeLa struttura del risultato
GET /open/{kind}/{id}Signed-in settingsThe result envelopeLa struttura del risultato

UPDATED 2026-10-03REVIEWED 2026-10-03

Fincanva is for education and illustration only. It is not personalised financial advice, and past or simulated results do not predict future ones. Read the Terms Addendum

DOCS · EN — IT