{"openapi":"3.1.0","info":{"title":"FRED API (Bowmark)","version":"e833508f87ff","description":"US economic data series search, releases and their publication calendar, the agencies FRED republishes data from, series metadata, and FRED's own category tree, off the St. Louis Fed's FRED.\n\nEvery function Bowmark has for FRED (fred.stlouisfed.org) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/fred/listReleases":{"post":{"operationId":"listReleases","summary":"Lists FRED's economic data releases — the named publications its series arrive in (Employment Situation, Consumer Price Index, Gross Domestic Product, …).","description":"Lists FRED's economic data releases — the named publications its series arrive in (Employment Situation, Consumer Price Index, Gross Domestic Product, …). Called bare it returns the whole catalogue (330 at time of measurement) with `dates: null`. Called with `releaseId` it returns that one release carrying its publication dates, each flagged `released` by FRED's own calendar, so a caller reads when it last came out and when it is next due. `from`/`to` (ISO dates) narrow that window; they default to one year either side of today.\n\nCalls `bowmark.providers.fred.listReleases`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<fredRelease[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"releaseId":{"type":"number"},"from":{"type":"string"},"to":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ releaseId?: number; from?: string; to?: string }`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/fred/listSources":{"post":{"operationId":"listSources","summary":"Lists the agencies and individuals FRED republishes data from (Bureau of Labor Statistics, Bureau of Economic Analysis, Federal Reserve Board, and ~120 others) — distinct from FRED itself, which is th","description":"Lists the agencies and individuals FRED republishes data from (Bureau of Labor Statistics, Bureau of Economic Analysis, Federal Reserve Board, and ~120 others) — distinct from FRED itself, which is the publisher rather than the originator. Called bare it returns the whole catalogue (124 at time of measurement) with `releases: null`. Called with `sourceId` it returns that one source carrying the releases it publishes, each with its own id/name/url, so a caller can tell who actually produced a number before reading it.\n\nCalls `bowmark.providers.fred.listSources`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<fredSource[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"sourceId":{"type":"number"}},"additionalProperties":true,"description":"TypeScript: `{ sourceId?: number }`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/fred/getSeriesInfo":{"post":{"operationId":"getSeriesInfo","summary":"Reads the metadata for one FRED series id — its full title, what the numbers actually ARE (`units`, e.g.","description":"Reads the metadata for one FRED series id — its full title, what the numbers actually ARE (`units`, e.g. \"Billions of Chained 2017 Dollars\"), how often it updates (`frequency`), whether it is seasonally adjusted, the date range of observations FRED holds, and FRED's own last-revised stamp. Call it before reading any value: a number with no units and no seasonal-adjustment basis is not comparable to anything. Ids are FRED's own — GDPC1 (real GDP), UNRATE (unemployment rate), CPIAUCSL (CPI) — and an id FRED does not publish comes back as a caller-fixable error naming the problem rather than as an empty result.\n\nCalls `bowmark.providers.fred.getSeriesInfo`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<fredSeries>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"seriesId":{"type":"string","description":"TypeScript: `string`"}},"required":["seriesId"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/fred/getSeriesObservations":{"post":{"operationId":"getSeriesObservations","summary":"Reads the actual numbers for a FRED series — the dated observations themselves, oldest first, with a missing period returned as `value: null` rather than as a `NaN` or a silently dropped row.","description":"Reads the actual numbers for a FRED series — the dated observations themselves, oldest first, with a missing period returned as `value: null` rather than as a `NaN` or a silently dropped row. Called bare (`getSeriesObservations(\"GDPC1\")`) it returns the series' full history; `from`/`to` (ISO yyyy-mm-dd) narrow the window. It also runs FRED's own transforms server-side so a caller never has to recompute one: `units` converts the level to a change (`pc1` percent change from a year ago — the usual way to read inflation off CPIAUCSL — plus `pch`, `chg`, `log` and the rest of FRED's ten codes), and `frequency` with `aggregationMethod` collapses a series to a coarser period (`{ frequency: \"a\", aggregationMethod: \"avg\" }` turns the monthly unemployment rate into annual averages). The result carries the applied transform and the served row bounds; its realtime fields are `null` because the keyless CSV publishes no vintage envelope. This is the function to call once `searchSeries`/`getSeriesInfo` has identified the right series id — e.g. A191RL1Q225SBEA for the US real GDP growth rate.\n\nCalls `bowmark.providers.fred.getSeriesObservations`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<fredObservations>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"type":"string"},{"type":"object","properties":{"seriesId":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"units":{"type":"string"},"frequency":{"type":"string"},"aggregationMethod":{"type":"string"}},"required":["seriesId"],"additionalProperties":true}],"description":"TypeScript: `string | { seriesId: string; from?: string; to?: string; units?: string; frequency?: string; aggregationMethod?: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/fred/browseCategory":{"post":{"operationId":"browseCategory","summary":"Browses FRED's category tree the way fred.stlouisfed.org/categories does — the category itself (id/name/parent), its immediate child categories, and the series filed directly under it, each carrying t","description":"Browses FRED's category tree the way fred.stlouisfed.org/categories does — the category itself (id/name/parent), its immediate child categories, and the series filed directly under it, each carrying the same full metadata getSeriesInfo returns (units, frequency, seasonal adjustment, observation range, last updated) so a caller can read them straight off a browsed result with no second call. Series come back MOST POPULAR FIRST, which is FRED's own ordering for a category. Called bare it starts at the root (id 0). FRED organizes its ~800,000 series into a real hierarchy (e.g. Money, Banking & Finance > Interest Rates > Treasury Constant Maturity), so this is how a caller explores 'what's available in this area' before knowing a series id to look up directly. `seriesTotal` is FRED's own count for the category and `seriesTruncated` says whether you got all of it: FRED's listing serves at most 1,500 series per category, so the handful of enormous ones (Housing is 54,800) come back as the most popular 1,500 and say so. An unknown category id comes back as a caller-fixable error.\n\nCalls `bowmark.providers.fred.browseCategory`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<fredCategory>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"categoryId":{"type":"number","description":"TypeScript: `number`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/fred/searchSeries":{"post":{"operationId":"searchSeries","summary":"Runs FRED's own search — the way fred.stlouisfed.org's search bar does — and returns matching series with the same full metadata getSeriesInfo returns (id, title, units, frequency, seasonal adjustment","description":"Runs FRED's own search — the way fred.stlouisfed.org's search bar does — and returns matching series with the same full metadata getSeriesInfo returns (id, title, units, frequency, seasonal adjustment, observation range, last updated), most-relevant-first, which is FRED's own default ordering. Called bare (`searchSeries(\"unemployment rate\")`) it returns the top 20 matches; `limit` (up to 120) asks for more. This is the entry point for finding a series id from a plain-English indicator name — call it before getSeriesInfo or getSeriesObservations when the series id is not already known. A query matching nothing returns an empty array rather than an error.\n\nCalls `bowmark.providers.fred.searchSeries`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<fredSeries[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"type":"string"},{"type":"object","properties":{"query":{"type":"string"},"limit":{"type":"number"}},"required":["query"],"additionalProperties":true}],"description":"TypeScript: `string | { query: string; limit?: number }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}}}}}