REST API

Every f1ow tool is also a REST resource. The tools, credentials and balance are the same as over MCP, so there is no MCP client to run.

A requestCopy Anchor Link

curl "https://mcp.f1ow.com/v1/derivatives/funding/BTC" \
  -H "Authorization: Bearer $F1OW_API_KEY"

Path segments and query parameters map one-to-one to the tool's arguments. Arrays are comma-separated (?symbols=BTC,ETH). The trade-plan check takes a JSON body:

curl -X POST "https://mcp.f1ow.com/v1/research/trade-plan" \
  -H "Authorization: Bearer $F1OW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"symbol":"BTC","entry":70000,"stop":68000,"target":75000,"account_size":10000,"risk_percent":1}'

Each tool page lists its path, parameters and ready-to-run cURL, TypeScript and Python examples.

ResponsesCopy Anchor Link

The body is the tool's JSON result, typed per tool in the OpenAPI spec:

{
  "symbol": "BTC",
  "...": "the tool's fields",
  "generatedAt": "2026-11-07T15:36:14Z"
}

• Every tool returns a JSON object. The fields are documented on its tool page.
• generatedAt is when the data was produced, from the source's timestamp where it has one.
• There is no text report here. The model-readable report is MCP-only: connect over MCP to get it next to the same JSON.

ErrorsCopy Anchor Link

Errors are RFC 9457 problem details (application/problem+json):

{
  "type": "urn:problem-type:f1ow:validation",
  "title": "One or more arguments are invalid",
  "status": 400,
  "detail": "See 'errors' for each invalid argument.",
  "instance": "/v1/market/candles/BTC",
  "errors": { "interval": ["must be one of: 1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d, 1w"] }
}

SpecsCopy Anchor Link

• OpenAPI 3.1: import it into Postman, Insomnia or a code generator. It includes an example request for every operation.
• API catalog (RFC 9727)

For agents: this page as Markdown · all docs