Docs
Api referenceMarketlabs

Today for you: your positions, events and research for the next hours

Request

Synthetic example for the production API. Replace YOUR_API_KEY and the ids. Do not send it against a live account until you mean to.

curl -X GET "https://api.fxapis.com/v1/marketlabs/today" \
  -H "Authorization: Bearer YOUR_API_KEY"
GET
/v1/marketlabs/today

Events in the next hours (default 48) for your held and watched currencies, your open positions and pending orders against them (needs trading:read as well), each pair's research lean, and what changed in the last 24 hours. Research, not trading advice.

Authorization

apiKey
AuthorizationBearer <token>

Authorization: Bearer fx_live_<id>_<secret>.

A key is shown once, at creation. We cannot show it again or recover it for you. Keys carry a label (live or test) in the key itself, so each configuration is easy to tell apart. Both reach real brokers: test with a broker demo account.

Scopes are per key. A key without accounts:write can read accounts and nothing else.

In: header

Query Parameters

hours?integer
Range24 <= value <= 72
timeZone?string

IANA time zone, e.g. Europe/London. Times stay in UTC.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.fxapis.com/v1/marketlabs/today"
{  "data": {    "generatedAt": "2019-08-24T14:15:22Z",    "window": {      "from": "2019-08-24T14:15:22Z",      "to": "2019-08-24T14:15:22Z",      "hours": 0,      "timeZone": null    },    "exposure": {      "available": true,      "reason": "string",      "accounts": [        {          "accountId": "string",          "name": "string",          "state": "string",          "observedAt": null,          "stale": true,          "items": [            {              "kind": "position",              "id": "string",              "symbol": "string",              "side": "buy",              "volume": "string",              "currencies": [                "string"              ],              "unmapped": true,              "pair": null,              "nextEvent": null,              "eventCount": 0            }          ]        }      ],      "ordersNote": "string",      "eventsAvailable": true    },    "upcoming": {      "available": true,      "reason": "string",      "events": [        {          "id": "string",          "title": "string",          "occurredAt": "2019-08-24T14:15:22Z",          "currency": "string",          "kind": "release",          "impact": "high",          "unit": null,          "period": null,          "previous": null,          "actual": null,          "revisedPrevious": null,          "forecast": null,          "forecastSource": null,          "status": "scheduled",          "releasedAt": null,          "confirmed": true,          "source": "string",          "figureSource": null,          "attribution": "string",          "held": true        }      ]    },    "leans": {      "available": true,      "reason": "string",      "pairs": [        {          "symbol": "string",          "held": true,          "watched": true,          "latest": null,          "previous": null        }      ]    },    "sinceYesterday": {      "available": true,      "reason": "string",      "released": [        {          "id": "string",          "title": "string",          "occurredAt": "2019-08-24T14:15:22Z",          "currency": "string",          "kind": "release",          "impact": "high",          "unit": null,          "period": null,          "previous": null,          "actual": null,          "revisedPrevious": null,          "forecast": null,          "forecastSource": null,          "status": "scheduled",          "releasedAt": null,          "confirmed": true,          "source": "string",          "figureSource": null,          "attribution": "string"        }      ],      "leanChanges": [        {          "symbol": "string",          "horizon": "string",          "from": null,          "to": null,          "reportId": "string"        }      ],      "headlines": [        {          "id": "string",          "title": "string",          "domain": "string",          "seen": "2019-08-24T14:15:22Z",          "source": "string",          "currencies": [            "string"          ],          "sourceName": null,          "summary": null,          "url": null        }      ]    },    "sources": [      {        "id": "string",        "name": "string",        "attribution": "string",        "creditUrl": null,        "lastSuccess": null,        "lastFailureAt": null,        "state": "fresh"      }    ]  },  "requestId": "string"}