Endpoints
GET /funds/{isin}, POST /funds (batch), GET /search, POST /portfolio, GET /overlap, GET /me, the demo endpoint.| Endpoint | What it does | Credits |
|---|---|---|
GET /funds/{isin} | Structured factsheet for one ISIN. | 1 |
POST /funds | Batch lookup, up to the plan's batch size per call. | 1 per ISIN answered |
GET /search | Name, issuer or ISIN-prefix search over loaded funds. | free |
POST /portfolio | Weighted look-through across funds. | 1 per position |
GET /overlap | Holdings overlap between two or more funds. | 1 per ISIN |
GET /changes | Change feed: tracked fields that moved between refreshes (Scale+). | free |
GET /webhooks | Signed POSTs when a fund changes; manage endpoints (Scale+). | free |
GET /export | Every matching fund as NDJSON, optionally gzipped (Scale+). | 1 per call |
POST /extract | Turn any KID / KIID / factsheet PDF into the same JSON shape (Pro+). | 5 per document |
GET /me | Plan and credits for the calling key. | free |
GET /demo/funds/{isin} | Keyless read of an already-loaded fund (30/min per IP). | none, no key |
GET /scpi/{idOrIsin} | Structured data for one French SCPI (slug, ISIN or name). | 1 |
GET /scpi | Name, manager or ISIN search over the SCPI universe. | free |
GET /funds/{isin}
Returns the structured factsheet for one ISIN. The path segment is validated (12 characters, country prefix, checksum) and normalised to upper case. One credit.
Response envelope
| Field | Type | Description |
|---|---|---|
isin | string | Canonical upper-case ISIN that was resolved. |
name | string | null | Fund / share-class name. |
cached | boolean | true when the payload was served from the 24-hour cache, false when it was refreshed for this request. |
generatedAt | string (ISO 8601) | When the payload was produced. |
expiresAt | string (ISO 8601) | When the payload will be considered stale and refreshed on the next request. |
plan | "free" | "starter" | "pro" | "scale" | "enterprise" | Plan of the API key used for the request. |
quota | { limit: number | null; remaining: number | null; used: number; overageUsed: number; resetAt: string; burst: { limit: number | null; remaining: number | null } } | Credit state after this request: monthly credits (limit), credits left, credits used this month, requests billed as overage, the next monthly reset (UTC) and the per-minute burst allowance. null limit means metered / unlimited. |
data | object | The structured factsheet. See the field reference below. |
200 OK — IE00B4L5Y983 (performance series shortened) — json
The complete data shape is in the field reference.
POST /funds — batch
Send up to the plan's batch size (Free 1, Starter 10, Pro 50, Scale 200, Enterprise 1,000) in one call. Funds already in the 24-hour store are answered immediately; cold ones are loaded a few at a time within the request budget, and anything left is returned as pending and warmed in the background — re-send those ISINs a minute later. One credit per ISIN with status ok or not_found; pending and invalid are free.
Request body — json
Response (data shortened) — json
wait: false answers from the store only and returns cold ISINs as pending at once — use it from a request handler that must respond quickly, then poll.
GET /search
?q= a fund name, issuer, or the first characters of an ISIN; &limit= up to 50. Searches the funds already loaded into the store (it grows with every request and with the nightly refresh), so a brand-new fund appears once someone has requested it by ISIN. Free; counts towards the per-minute burst limit.
json
POST /portfolio — look-through
Post positions with weights (any scale; they are normalised to 100). The response aggregates each fund's breakdowns by its portfolio weight: asset allocation, sector, country, region, credit quality, currency split and combined top holdings, plus the blended TER, the weighted SRRI and a coverage figure on every block (the share of the portfolio whose funds disclose that breakdown). One credit per position answered.
Request body — json
Response (shortened) — json
GET /overlap
?isins=A,B,C — for every pair, the overlap is the sum over shared holdings of the smaller of the two weights, matched on the issuer name (so “Apple Inc” and “APPLE INC.” match). Funds that disclose only their top ten show a lower bound; disclosed tells you how much of each portfolio was visible. One credit per ISIN answered.
json
GET /changes — change feed
Every refresh is compared with the payload it replaces. When one of the tracked fields moves — headlineMetrics.ter, riskRating, keyFacts.aum, keyFacts.manager, keyFacts.distribution, keyFacts.holdings, benchmarkName, investmentObjective or the top-5 topHoldings — a fund.changed row is written; when the as-of date moves, a fund.refreshed row. Poll with ?since= (ISO timestamp; default the last 7 days), optionally &isins= and &event=; use nextSince for the next call. Scale and Enterprise; free.
json
A fund only changes when it is refreshed, so the feed reflects the ISINs your account (and everyone else) requests plus the scheduled universe; a fund nobody has loaded for weeks has no entries.
Webhooks
Instead of polling, register an https endpoint and receive a signed POST for every fund.changed / fund.refreshed event, for every fund or for a list of ISINs. Manage endpoints from the dashboard or the API: GET /webhooks, POST /webhooks { "url", "events", "isins" } (returns the signing secret once), POST /webhooks/{id} { "action": "test" | "enable" | "disable" }, DELETE /webhooks/{id}. Scale and Enterprise.
Delivery body — json
Verify the X-FundFacts-Signature: t=<unix>,v1=<hex> header: v1 is HMAC-SHA256 over `${t}.${rawBody}` with your secret; reject timestamps older than five minutes. Answer 2xx within 10 seconds; anything else is retried up to six times with back-off (1 min → 24 h), after which the endpoint is disabled.
Node.js verification — ts
GET /export — bulk NDJSON
Streams every fund in the store that matches ?issuer=, &assetClass=, ¤cy=, &since= (refreshed after this date), one { isin, name, generatedAt, expiresAt, data } envelope per line. Gzipped when the client accepts it (force with &gzip=1 or off with &gzip=0). One credit per call regardless of size. Scale and Enterprise.
POST /extract — any document to JSON
The extraction that powers the API, on your own documents: send a PRIIPs KID, a UCITS KIID or a factsheet and get the same data shape back — for funds whose issuer is not covered, private funds, insurers' unit-linked funds, or a document pile from a due-diligence pack. The regulated KID layout is read deterministically (risk indicator, cost table, SFDR article, holding period); the rest is read by the document model. Five credits per document. Pro and up.
json
Scanned PDFs without a text layer are not supported. Files up to 8 MB; URLs are fetched respecting the publisher's robots.txt.
GET /me
Plan and credit state for the key used; free. Call it once at startup to confirm the key works, not on every request.
GET /demo/funds/{isin}
No key needed. Serves a fund that is already in the store (the same payload as the authenticated endpoint, without plan and quota), 30 requests per minute per IP. It never loads anything: an ISIN nobody has requested yet returns 404 not_cached. Use it to inspect the payload shape before signing up, or from the free tools.
Response headers
X-RateLimit-Limit (credits per month), X-RateLimit-Remaining, X-RateLimit-Reset (unix seconds of the monthly reset), X-Burst-Limit and X-Burst-Remaining (per minute) on every authenticated response; Retry-After on 429. See credits & rate limits.