Documentation

GET /api/fix/mine

The state of a Fix run, or this account's Fix subscriptions.

RequestGET /api/fix/mine
AuthenticationSession cookie optional
Handlerbackend/fixtool.py

What it does

Serves the run's state, step and note while it is running, and the account's subscription list once one exists. `source` names the query behind the answer, so the reader can see where it came from.

Authentication

Session cookie optional. The endpoint answers with or without ff_session, but the body is scoped to the session when one is present.

Parameters

ParameterInTypeRequiredDescription
ff_sessioncookiestringOptionalThe session identifier. Omit it on the first call and store the value the response sets; every later call must send the same one or the engine treats the caller as a new visitor with no holds and no claims.

Request

The cookie jar carries the session between calls. Angle-bracketed values are the parameter types from the table above.

curl -s -b cookies.txt -c cookies.txt \
  "https://flowfinds.ai/api/fix/mine"
const res = await fetch("https://flowfinds.ai/api/fix/mine", {
  method: "GET",
  credentials: "include",
});
const data = await res.json();
import requests

s = requests.Session()
r = s.get("https://flowfinds.ai/api/fix/mine")
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  "$FLOWFINDS_ORIGIN/api/fix/mine"

Responses

200A run is in progress.

FieldTypeDescription
statestring`running` by default.
stepstringWhat the run is doing.
notestringAny note the run has emitted.
urlstring`/fix/<token>`.

200Subscriptions were read.

FieldTypeDescription
statusstring`ok`.
accountstring | nullThe account, or null.
subscriptionsarrayThe account's Fix subscriptions.
every_daysnumberThe recheck period.
sourcestring`GET /api/fix/mine → fix_subs`.

Errors

StatusReasonWhen
404not_foundNo run or subscription matches.

Related

Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.