Last active
March 17, 2025 01:35
-
-
Save sandalsoft/93a68e268f1c46cb4332ff52c47e45ad to your computer and use it in GitHub Desktop.
FRED OAS
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| openapi: 3.0.0 | |
| info: | |
| title: FRED API | |
| description: | | |
| API for accessing economic data from the Federal Reserve Economic Data (FRED) | |
| and Archival Federal Reserve Economic Data (ALFRED) databases, provided by | |
| the Federal Reserve Bank of St. Louis. | |
| version: 1.0.0 | |
| servers: | |
| - url: https://api.stlouisfed.org | |
| paths: | |
| /fred/series: | |
| get: | |
| summary: Get an economic data series | |
| description: Retrieves metadata about a specific economic data series identified by series_id. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: series_id | |
| in: query | |
| description: The ID of the series to retrieve. | |
| required: true | |
| schema: | |
| type: string | |
| example: GNPCA | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: 2013-08-14 | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: 2013-08-14 | |
| responses: | |
| "200": | |
| description: Successful response with series metadata. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/SeriesResponse" | |
| "400": | |
| description: Bad request, such as invalid or unregistered API key. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/series/observations: | |
| get: | |
| summary: Get observations for a series | |
| description: Retrieves the data values (observations) for a specific economic data series. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: series_id | |
| in: query | |
| description: The ID of the series to retrieve observations for. | |
| required: true | |
| schema: | |
| type: string | |
| example: GNPCA | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: 2013-08-14 | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: 2013-08-14 | |
| # - name: observation_start | |
| # in: query | |
| # description: The start date for observations in YYYY-MM-DD format. | |
| # schema: | |
| # type: string | |
| # format: date | |
| # example: 1929-01-01 | |
| # - name: observation_end | |
| # in: query | |
| # description: The end date for observations in YYYY-MM-DD format. | |
| # schema: | |
| # type: string | |
| # format: date | |
| # example: 2012-01-01 | |
| # - name: limit | |
| # in: query | |
| # description: Maximum number of observations to return. | |
| # schema: | |
| # type: integer | |
| # minimum: 1 | |
| # maximum: 100000 | |
| # default: 100000 | |
| # - name: offset | |
| # in: query | |
| # description: Number of observations to skip before returning results. | |
| # schema: | |
| # type: integer | |
| # minimum: 0 | |
| # default: 0 | |
| # - name: sort_order | |
| # in: query | |
| # description: Order of the observations. | |
| # schema: | |
| # type: string | |
| # enum: [asc, desc] | |
| # default: asc | |
| # - name: frequency | |
| # in: query | |
| # description: Frequency to aggregate or filter observations. | |
| # schema: | |
| # type: string | |
| # enum: [d, w, bw, m, q, sa, a] | |
| # - name: aggregation_method | |
| # in: query | |
| # description: Method to aggregate observations when frequency is specified. | |
| # schema: | |
| # type: string | |
| # enum: [avg, sum, eop] | |
| # default: avg | |
| # - name: output_type | |
| # in: query | |
| # description: Format of the observation data output. | |
| # schema: | |
| # type: integer | |
| # enum: [1, 2, 3, 4] | |
| # default: 1 | |
| # - name: vintage_dates | |
| # in: query | |
| # description: Comma-separated list of vintage dates in YYYY-MM-DD format. | |
| # schema: | |
| # type: string | |
| # example: 2020-01-01,2021-01-01 | |
| responses: | |
| "200": | |
| description: Successful response with series observations. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ObservationsResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/category/series: | |
| get: | |
| summary: Get series in a category | |
| description: Retrieves economic data series that belong to a specified category. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: category_id | |
| in: query | |
| description: The ID of the category to retrieve series for. | |
| required: true | |
| schema: | |
| type: integer | |
| example: 125 | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: 2017-08-01 | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: 2017-08-01 | |
| - name: limit | |
| in: query | |
| description: Maximum number of series to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of series to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: | |
| [ | |
| series_id, | |
| title, | |
| units, | |
| frequency, | |
| seasonal_adjustment, | |
| realtime_start, | |
| realtime_end, | |
| last_updated, | |
| observation_start, | |
| observation_end, | |
| popularity, | |
| group_popularity, | |
| ] | |
| default: series_id | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| - name: filter_variable | |
| in: query | |
| description: The attribute to filter results by. | |
| schema: | |
| type: string | |
| enum: [frequency, units, seasonal_adjustment] | |
| - name: filter_value | |
| in: query | |
| description: The value of the filter_variable attribute to filter results by. | |
| schema: | |
| type: string | |
| - name: tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names that series match all of. | |
| schema: | |
| type: string | |
| example: "income;bea" | |
| - name: exclude_tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names that series match none of. | |
| schema: | |
| type: string | |
| example: "discontinued;annual" | |
| responses: | |
| "200": | |
| description: Successful response with series in the specified category. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/CategorySeriesResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/release: | |
| get: | |
| summary: Get a release of economic data | |
| description: Retrieves metadata about a specific economic data release identified by release_id. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: release_id | |
| in: query | |
| description: The ID of the release to retrieve. | |
| required: true | |
| schema: | |
| type: integer | |
| example: 53 | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-08-14" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-08-14" | |
| responses: | |
| "200": | |
| description: Successful response with release data. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ReleaseResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/releases: | |
| get: | |
| summary: Get all releases of economic data | |
| description: Retrieves all releases of economic data with pagination support. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-08-13" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-08-13" | |
| - name: limit | |
| in: query | |
| description: Maximum number of releases to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of releases to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: | |
| [release_id, name, press_release, realtime_start, realtime_end] | |
| default: release_id | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| responses: | |
| "200": | |
| description: Successful response with list of releases. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ReleasesResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/series/search: | |
| get: | |
| summary: Get economic data series that match search text | |
| description: Searches for economic data series that match specified search text or series ID patterns. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: search_text | |
| in: query | |
| description: The words to match against economic data series. | |
| required: true | |
| schema: | |
| type: string | |
| example: "monetary service index" | |
| - name: search_type | |
| in: query | |
| description: Determines the type of search to perform. | |
| required: false | |
| schema: | |
| type: string | |
| enum: [full_text, series_id] | |
| default: full_text | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2017-08-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2017-08-01" | |
| - name: limit | |
| in: query | |
| description: Maximum number of series to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of series to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: | |
| [ | |
| search_rank, | |
| series_id, | |
| title, | |
| units, | |
| frequency, | |
| seasonal_adjustment, | |
| realtime_start, | |
| realtime_end, | |
| last_updated, | |
| observation_start, | |
| observation_end, | |
| popularity, | |
| group_popularity, | |
| ] | |
| default: search_rank | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| - name: filter_variable | |
| in: query | |
| description: The attribute to filter results by. | |
| schema: | |
| type: string | |
| enum: [frequency, units, seasonal_adjustment] | |
| - name: filter_value | |
| in: query | |
| description: The value of the filter_variable attribute to filter results by. | |
| schema: | |
| type: string | |
| - name: tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names that series match all of. | |
| schema: | |
| type: string | |
| example: "usa;m2" | |
| - name: exclude_tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names that series match none of. | |
| schema: | |
| type: string | |
| example: "discontinued;m1" | |
| responses: | |
| "200": | |
| description: Successful response with matching series. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/SeriesSearchResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/category: | |
| get: | |
| summary: Get a category | |
| description: Retrieves metadata about a specific economic data category identified by category_id. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: category_id | |
| in: query | |
| description: The ID of the category to retrieve. | |
| schema: | |
| type: integer | |
| default: 0 | |
| example: 125 | |
| responses: | |
| "200": | |
| description: Successful response with category data. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/CategoryResponse" | |
| "400": | |
| description: Bad request, such as invalid parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/category/children: | |
| get: | |
| summary: Get child categories for a parent category | |
| description: Retrieves child categories for a specified parent category. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: category_id | |
| in: query | |
| description: The ID of the parent category. | |
| required: true | |
| schema: | |
| type: integer | |
| example: 125 | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2017-08-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2017-08-01" | |
| responses: | |
| "200": | |
| description: Successful response with child categories. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/CategoriesResponse" | |
| "400": | |
| description: Bad request, such as invalid parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/category/related: | |
| get: | |
| summary: Get related categories for a category | |
| description: Retrieves categories related to a specified category. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: category_id | |
| in: query | |
| description: The ID of the category. | |
| required: true | |
| schema: | |
| type: integer | |
| example: 125 | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2017-08-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2017-08-01" | |
| responses: | |
| "200": | |
| description: Successful response with related categories. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/CategoriesResponse" | |
| "400": | |
| description: Bad request, such as invalid parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/category/tags: | |
| get: | |
| summary: Get FRED tags for a category | |
| description: Retrieves FRED tags assigned to series in a specified category. Series are assigned tags and categories, making it possible to get tags for a category indirectly through series. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: category_id | |
| in: query | |
| description: The ID of the category to get tags for. | |
| required: true | |
| schema: | |
| type: integer | |
| example: 125 | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2017-08-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2017-08-01" | |
| - name: tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names to only include in the response. | |
| schema: | |
| type: string | |
| example: "trade;goods" | |
| - name: tag_group_id | |
| in: query | |
| description: A tag group ID to filter tags by type. | |
| schema: | |
| type: string | |
| enum: [freq, gen, geo, geot, rls, seas, src] | |
| - name: search_text | |
| in: query | |
| description: The words to find matching tags with. | |
| schema: | |
| type: string | |
| - name: limit | |
| in: query | |
| description: Maximum number of tags to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of tags to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: [series_count, popularity, created, name, group_id] | |
| default: series_count | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| responses: | |
| "200": | |
| description: Successful response with tags for the category. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/TagsResponse" | |
| "400": | |
| description: Bad request, such as invalid parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/category/related_tags: | |
| get: | |
| summary: Get related FRED tags for a category | |
| description: Retrieves the related FRED tags for a category. A related tag is a tag that has been assigned to one or more series that match all tags in the tag_names parameter and are part of the specified category. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: category_id | |
| in: query | |
| description: The ID of the category. | |
| required: true | |
| schema: | |
| type: integer | |
| example: 125 | |
| - name: tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names that series match all of. | |
| required: true | |
| schema: | |
| type: string | |
| example: "trade;goods" | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2017-08-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2017-08-01" | |
| - name: exclude_tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names to exclude from the response. | |
| schema: | |
| type: string | |
| example: "discontinued;annual" | |
| - name: tag_group_id | |
| in: query | |
| description: A tag group ID to filter tags by type. | |
| schema: | |
| type: string | |
| enum: [freq, gen, geo, geot, rls, seas, src] | |
| - name: search_text | |
| in: query | |
| description: The words to find matching tags with. | |
| schema: | |
| type: string | |
| - name: limit | |
| in: query | |
| description: Maximum number of tags to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of tags to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: [series_count, popularity, created, name, group_id] | |
| default: series_count | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| responses: | |
| "200": | |
| description: Successful response with related tags for the category. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/TagsResponse" | |
| "400": | |
| description: Bad request, such as invalid parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/releases/dates: | |
| get: | |
| summary: Get release dates for all releases | |
| description: Retrieves release dates for all releases of economic data. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| - name: limit | |
| in: query | |
| description: Maximum number of release dates to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of release dates to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: [release_date, release_id, release_name] | |
| default: release_date | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| - name: include_release_date_with_no_data | |
| in: query | |
| description: Determines whether release dates for releases without data are included. | |
| schema: | |
| type: boolean | |
| default: false | |
| responses: | |
| "200": | |
| description: Successful response with release dates. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ReleaseDatesResponse" | |
| "400": | |
| description: Bad request, such as invalid parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/release/dates: | |
| get: | |
| summary: Get release dates for a specific release | |
| description: Retrieves release dates for a specified release of economic data. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: release_id | |
| in: query | |
| description: The ID of the release. | |
| required: true | |
| schema: | |
| type: integer | |
| example: 53 | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| - name: limit | |
| in: query | |
| description: Maximum number of release dates to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of release dates to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| - name: include_release_date_with_no_data | |
| in: query | |
| description: Determines whether release dates for releases without data are included. | |
| schema: | |
| type: boolean | |
| default: false | |
| responses: | |
| "200": | |
| description: Successful response with release dates for the specified release. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ReleaseDatesResponse" | |
| "400": | |
| description: Bad request, such as invalid parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/release/sources: | |
| get: | |
| summary: Get sources for a release | |
| description: Retrieves the sources for a specified release of economic data. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: release_id | |
| in: query | |
| description: The ID of the release. | |
| required: true | |
| schema: | |
| type: integer | |
| example: 53 | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| responses: | |
| "200": | |
| description: Successful response with sources for the specified release. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/SourcesResponse" | |
| "400": | |
| description: Bad request, such as invalid parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/release/tags: | |
| get: | |
| summary: Get FRED tags for a release | |
| description: Retrieves FRED tags assigned to a release of economic data. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: release_id | |
| in: query | |
| description: The ID of the release. | |
| required: true | |
| schema: | |
| type: integer | |
| example: 53 | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| - name: tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names to only include in the response. | |
| schema: | |
| type: string | |
| example: "gdp;bea" | |
| - name: tag_group_id | |
| in: query | |
| description: A tag group ID to filter tags by type. | |
| schema: | |
| type: string | |
| enum: [freq, gen, geo, geot, rls, seas, src] | |
| - name: search_text | |
| in: query | |
| description: The words to find matching tags with. | |
| schema: | |
| type: string | |
| - name: limit | |
| in: query | |
| description: Maximum number of tags to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of tags to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: [series_count, popularity, created, name, group_id] | |
| default: series_count | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| responses: | |
| "200": | |
| description: Successful response with tags for the specified release. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/TagsResponse" | |
| "400": | |
| description: Bad request, such as invalid parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/release/related_tags: | |
| get: | |
| summary: Get related FRED tags for a release | |
| description: Retrieves the related FRED tags for a release. A related tag is a tag that has been assigned to one or more series that match all tags in the tag_names parameter and are part of the specified release. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: release_id | |
| in: query | |
| description: The ID of the release. | |
| required: true | |
| schema: | |
| type: integer | |
| example: 53 | |
| - name: tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names that series match all of. | |
| required: true | |
| schema: | |
| type: string | |
| example: "gdp;bea" | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| - name: exclude_tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names to exclude from the response. | |
| schema: | |
| type: string | |
| example: "discontinued;annual" | |
| - name: tag_group_id | |
| in: query | |
| description: A tag group ID to filter tags by type. | |
| schema: | |
| type: string | |
| enum: [freq, gen, geo, geot, rls, seas, src] | |
| - name: search_text | |
| in: query | |
| description: The words to find matching tags with. | |
| schema: | |
| type: string | |
| - name: limit | |
| in: query | |
| description: Maximum number of tags to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of tags to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: [series_count, popularity, created, name, group_id] | |
| default: series_count | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| responses: | |
| "200": | |
| description: Successful response with related tags for the specified release. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/TagsResponse" | |
| "400": | |
| description: Bad request, such as invalid parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/release/tables: | |
| get: | |
| summary: Get tables for a release | |
| description: Retrieves the tables for a release. Releases may be summarized in multiple tables with each table representing a different frequency of data or a different time range. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: release_id | |
| in: query | |
| description: The ID of the release. | |
| required: true | |
| schema: | |
| type: integer | |
| example: 53 | |
| - name: element_id | |
| in: query | |
| description: The ID for an element associated with the table of interest. This is often a geographical application. | |
| schema: | |
| type: integer | |
| example: 12345 | |
| - name: include_observation_values | |
| in: query | |
| description: Whether to include observations values along with the dimensions. | |
| schema: | |
| type: boolean | |
| default: false | |
| - name: observation_date | |
| in: query | |
| description: The observation date to include with each series. YYYY-MM-DD formatted string. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| responses: | |
| "200": | |
| description: Successful response with tables for the specified release. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ReleaseTables" | |
| "400": | |
| description: Bad request, such as invalid parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/series/categories: | |
| get: | |
| summary: Get categories for an economic data series | |
| description: Retrieves the categories for a specified economic data series. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: series_id | |
| in: query | |
| description: The ID for a series. | |
| required: true | |
| schema: | |
| type: string | |
| example: "EXJPUS" | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-08-14" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-08-14" | |
| responses: | |
| "200": | |
| description: Successful response with categories for the series. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/CategoriesResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/series/release: | |
| get: | |
| summary: Get the release for an economic data series | |
| description: Retrieves the release for a specified economic data series. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: series_id | |
| in: query | |
| description: The ID for a series. | |
| required: true | |
| schema: | |
| type: string | |
| example: "IRA" | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-08-14" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-08-14" | |
| responses: | |
| "200": | |
| description: Successful response with release data for the series. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ReleaseResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/series/search/tags: | |
| get: | |
| summary: Get FRED tags for a series search | |
| description: Retrieves FRED tags for economic data series that match search criteria. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: series_search_text | |
| in: query | |
| description: The words to match against economic data series. | |
| required: true | |
| schema: | |
| type: string | |
| example: "mortgage rate" | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| - name: tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names to only include in the response. | |
| schema: | |
| type: string | |
| example: "30-year;frb" | |
| - name: tag_group_id | |
| in: query | |
| description: A tag group ID to filter tags by type. | |
| schema: | |
| type: string | |
| enum: [freq, gen, geo, geot, rls, seas, src] | |
| - name: tag_search_text | |
| in: query | |
| description: The words to find matching tags with. | |
| schema: | |
| type: string | |
| - name: limit | |
| in: query | |
| description: Maximum number of tags to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of tags to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: [series_count, popularity, created, name, group_id] | |
| default: series_count | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| responses: | |
| "200": | |
| description: Successful response with tags for series search. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/TagsResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/series/search/related_tags: | |
| get: | |
| summary: Get related FRED tags for a series search | |
| description: Retrieves the related FRED tags for series that match search criteria. A related tag is a tag that has been assigned to one or more series that match all tags in the tag_names parameter and the search text. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: series_search_text | |
| in: query | |
| description: The words to match against economic data series. | |
| required: true | |
| schema: | |
| type: string | |
| example: "mortgage rate" | |
| - name: tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names that series match all of. | |
| required: true | |
| schema: | |
| type: string | |
| example: "30-year;frb" | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| - name: exclude_tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names to exclude from the response. | |
| schema: | |
| type: string | |
| example: "weekly;monthly" | |
| - name: tag_group_id | |
| in: query | |
| description: A tag group ID to filter tags by type. | |
| schema: | |
| type: string | |
| enum: [freq, gen, geo, geot, rls, seas, src] | |
| - name: tag_search_text | |
| in: query | |
| description: The words to find matching tags with. | |
| schema: | |
| type: string | |
| - name: limit | |
| in: query | |
| description: Maximum number of tags to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of tags to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: [series_count, popularity, created, name, group_id] | |
| default: series_count | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| responses: | |
| "200": | |
| description: Successful response with related tags for series search. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/TagsResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/series/tags: | |
| get: | |
| summary: Get FRED tags for a series | |
| description: Retrieves FRED tags for a specified series. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: series_id | |
| in: query | |
| description: The ID for a series. | |
| required: true | |
| schema: | |
| type: string | |
| example: "STLFSI" | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: [series_count, popularity, created, name, group_id] | |
| default: series_count | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| responses: | |
| "200": | |
| description: Successful response with tags for the series. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/TagsResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/series/updates: | |
| get: | |
| summary: Get economic data series sorted by when they were updated | |
| description: Retrieves economic data series sorted by when they were updated on the FRED server. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-07-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-07-03" | |
| - name: limit | |
| in: query | |
| description: Maximum number of series to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of series to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: filter_value | |
| in: query | |
| description: Filters results by a value of the filter_variable parameter. | |
| schema: | |
| type: string | |
| - name: filter_variable | |
| in: query | |
| description: The attribute to filter results by. | |
| schema: | |
| type: string | |
| enum: [frequency, units, seasonal_adjustment] | |
| - name: start_time | |
| in: query | |
| description: Start time for limiting results for a time range. The format is a ISO8601 timestamp (e.g., 2000-01-01 00:00:00). | |
| schema: | |
| type: string | |
| format: date-time | |
| example: "2000-01-01 00:00:00" | |
| - name: end_time | |
| in: query | |
| description: End time for limiting results for a time range. The format is a ISO8601 timestamp (e.g., 2000-01-01 00:00:00). | |
| schema: | |
| type: string | |
| format: date-time | |
| example: "2023-01-01 00:00:00" | |
| responses: | |
| "200": | |
| description: Successful response with updated series. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/SeriesResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/series/vintagedates: | |
| get: | |
| summary: Get vintage dates for a series | |
| description: Retrieves vintage dates for a specified economic data series. Vintage dates are the dates in history when a series' data values were revised or new data values were released. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: series_id | |
| in: query | |
| description: The ID for a series. | |
| required: true | |
| schema: | |
| type: string | |
| example: "GNPCA" | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| - name: limit | |
| in: query | |
| description: Maximum number of vintage dates to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 10000 | |
| default: 10000 | |
| - name: offset | |
| in: query | |
| description: Number of vintage dates to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| responses: | |
| "200": | |
| description: Successful response with vintage dates for the series. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/VintageDatesResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/source: | |
| get: | |
| summary: Get a source of economic data | |
| description: Retrieves a source of economic data. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: source_id | |
| in: query | |
| description: The ID of the source. | |
| required: true | |
| schema: | |
| type: integer | |
| example: 1 | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| responses: | |
| "200": | |
| description: Successful response with source data. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/SourceResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/sources: | |
| get: | |
| summary: Get all sources of economic data | |
| description: Retrieves all sources of economic data. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| - name: limit | |
| in: query | |
| description: Maximum number of sources to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of sources to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: [source_id, name, realtime_start, realtime_end] | |
| default: source_id | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| responses: | |
| "200": | |
| description: Successful response with sources data. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/SourcesResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/source/releases: | |
| get: | |
| summary: Get releases for a source | |
| description: Retrieves releases for a specified source. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: source_id | |
| in: query | |
| description: The ID of the source. | |
| required: true | |
| schema: | |
| type: integer | |
| example: 1 | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| - name: limit | |
| in: query | |
| description: Maximum number of releases to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of releases to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: | |
| [release_id, name, press_release, realtime_start, realtime_end] | |
| default: release_id | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| responses: | |
| "200": | |
| description: Successful response with releases for the source. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ReleasesResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/tags: | |
| get: | |
| summary: Get FRED tags | |
| description: Retrieves FRED tags. These tags are used to group series and can be used to help find related series. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| - name: tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names to only include in the response. | |
| schema: | |
| type: string | |
| example: "gdp;annual" | |
| - name: tag_group_id | |
| in: query | |
| description: A tag group ID to filter tags by type. | |
| schema: | |
| type: string | |
| enum: [freq, gen, geo, geot, rls, seas, src] | |
| - name: search_text | |
| in: query | |
| description: The words to find matching tags with. | |
| schema: | |
| type: string | |
| - name: limit | |
| in: query | |
| description: Maximum number of tags to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of tags to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: [series_count, popularity, created, name, group_id] | |
| default: series_count | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| responses: | |
| "200": | |
| description: Successful response with tags. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/TagsResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/related_tags: | |
| get: | |
| summary: Get related FRED tags | |
| description: Retrieves related FRED tags. A related tag is a tag that has been assigned to series that match all tags in the tag_names parameter. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names that series match all of. | |
| required: true | |
| schema: | |
| type: string | |
| example: "monetary aggregates;weekly" | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| - name: exclude_tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names to exclude from the response. | |
| schema: | |
| type: string | |
| example: "discontinued;annual" | |
| - name: tag_group_id | |
| in: query | |
| description: A tag group ID to filter tags by type. | |
| schema: | |
| type: string | |
| enum: [freq, gen, geo, geot, rls, seas, src] | |
| - name: search_text | |
| in: query | |
| description: The words to find matching tags with. | |
| schema: | |
| type: string | |
| - name: limit | |
| in: query | |
| description: Maximum number of tags to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of tags to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: [series_count, popularity, created, name, group_id] | |
| default: series_count | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| responses: | |
| "200": | |
| description: Successful response with related tags. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/TagsResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| /fred/tags/series: | |
| get: | |
| summary: Get economic data series matching tags | |
| description: Retrieves economic data series that match all tags in the tag_names parameter. | |
| parameters: | |
| - name: file_type | |
| in: query | |
| description: The format of the response (always json). | |
| schema: | |
| type: string | |
| enum: [json] | |
| default: json | |
| required: false | |
| allowEmptyValue: false | |
| example: "json" | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names that series match all of. | |
| required: true | |
| schema: | |
| type: string | |
| example: "slovenia;food;oecd" | |
| - name: realtime_start | |
| in: query | |
| description: The start date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-01-01" | |
| - name: realtime_end | |
| in: query | |
| description: The end date of the real-time period in YYYY-MM-DD format. | |
| schema: | |
| type: string | |
| format: date | |
| example: "2013-12-31" | |
| - name: exclude_tag_names | |
| in: query | |
| description: A semicolon delimited list of tag names that series match none of. | |
| schema: | |
| type: string | |
| example: "discontinued;annual" | |
| - name: limit | |
| in: query | |
| description: Maximum number of series to return. | |
| schema: | |
| type: integer | |
| minimum: 1 | |
| maximum: 1000 | |
| default: 1000 | |
| - name: offset | |
| in: query | |
| description: Number of series to skip before returning results. | |
| schema: | |
| type: integer | |
| minimum: 0 | |
| default: 0 | |
| - name: order_by | |
| in: query | |
| description: Order results by values of the specified attribute. | |
| schema: | |
| type: string | |
| enum: | |
| [ | |
| series_id, | |
| title, | |
| units, | |
| frequency, | |
| seasonal_adjustment, | |
| realtime_start, | |
| realtime_end, | |
| last_updated, | |
| observation_start, | |
| observation_end, | |
| popularity, | |
| group_popularity, | |
| ] | |
| default: series_id | |
| - name: sort_order | |
| in: query | |
| description: Sort results in ascending or descending order. | |
| schema: | |
| type: string | |
| enum: [asc, desc] | |
| default: asc | |
| responses: | |
| "200": | |
| description: Successful response with series matching the tags. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/SeriesResponse" | |
| "400": | |
| description: Bad request, such as missing required parameters. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/ErrorResponse" | |
| components: | |
| schemas: | |
| SeriesResponse: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| description: Start date of the real-time period. | |
| realtime_end: | |
| type: string | |
| format: date | |
| description: End date of the real-time period. | |
| seriess: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Series" | |
| required: | |
| - realtime_start | |
| - realtime_end | |
| - seriess | |
| Series: | |
| type: object | |
| properties: | |
| id: | |
| type: string | |
| description: Unique identifier of the series. | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| title: | |
| type: string | |
| description: Title of the series. | |
| observation_start: | |
| type: string | |
| format: date | |
| observation_end: | |
| type: string | |
| format: date | |
| frequency: | |
| type: string | |
| description: Frequency of the data (e.g., Annual, Monthly). | |
| frequency_short: | |
| type: string | |
| units: | |
| type: string | |
| description: Units of the data values. | |
| units_short: | |
| type: string | |
| seasonal_adjustment: | |
| type: string | |
| description: Seasonal adjustment status. | |
| seasonal_adjustment_short: | |
| type: string | |
| last_updated: | |
| type: string | |
| format: date-time | |
| description: Date and time of the last update. | |
| popularity: | |
| type: integer | |
| description: Popularity score of the series. | |
| group_popularity: | |
| type: integer | |
| description: Group popularity score of the series. | |
| notes: | |
| type: string | |
| description: Additional notes about the series. | |
| required: | |
| - id | |
| - title | |
| ObservationsResponse: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| observation_start: | |
| type: string | |
| format: date | |
| observation_end: | |
| type: string | |
| format: date | |
| units: | |
| type: string | |
| output_type: | |
| type: integer | |
| enum: [1, 2, 3, 4] | |
| file_type: | |
| type: string | |
| enum: [json] | |
| order_by: | |
| type: string | |
| sort_order: | |
| type: string | |
| enum: [asc, desc] | |
| count: | |
| type: integer | |
| description: Total number of observations available. | |
| offset: | |
| type: integer | |
| limit: | |
| type: integer | |
| observations: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Observation" | |
| required: | |
| - realtime_start | |
| - realtime_end | |
| - observation_start | |
| - observation_end | |
| - observations | |
| Observation: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| date: | |
| type: string | |
| format: date | |
| description: Date of the observation. | |
| value: | |
| type: string | |
| description: Value of the observation (can be numeric or "." for missing data). | |
| required: | |
| - date | |
| - value | |
| ErrorResponse: | |
| type: object | |
| properties: | |
| error_code: | |
| type: integer | |
| description: HTTP-like error code. | |
| example: 400 | |
| error_message: | |
| type: string | |
| description: Description of the error. | |
| example: Bad Request. Invalid request parameters. | |
| required: | |
| - error_code | |
| - error_message | |
| CategorySeriesResponse: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| order_by: | |
| type: string | |
| description: The attribute series are ordered by. | |
| sort_order: | |
| type: string | |
| enum: [asc, desc] | |
| description: The order results are sorted in. | |
| count: | |
| type: integer | |
| description: Total number of series matching the search criteria. | |
| offset: | |
| type: integer | |
| description: Number of series skipped. | |
| limit: | |
| type: integer | |
| description: Maximum number of series returned. | |
| seriess: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Series" | |
| required: | |
| - realtime_start | |
| - realtime_end | |
| - order_by | |
| - sort_order | |
| - count | |
| - offset | |
| - limit | |
| - seriess | |
| ReleaseResponse: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| releases: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Release" | |
| required: | |
| - realtime_start | |
| - realtime_end | |
| - releases | |
| Release: | |
| type: object | |
| properties: | |
| id: | |
| type: integer | |
| description: Unique identifier of the release. | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| name: | |
| type: string | |
| description: Name of the release. | |
| press_release: | |
| type: boolean | |
| description: Whether the release is a press release. | |
| link: | |
| type: string | |
| format: uri | |
| description: URL for more information about the release. | |
| notes: | |
| type: string | |
| description: Additional notes about the release. | |
| required: | |
| - id | |
| - realtime_start | |
| - realtime_end | |
| - name | |
| - press_release | |
| ReleasesResponse: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| order_by: | |
| type: string | |
| description: The attribute releases are ordered by. | |
| sort_order: | |
| type: string | |
| enum: [asc, desc] | |
| description: The order results are sorted in. | |
| count: | |
| type: integer | |
| description: Total number of releases matching the search criteria. | |
| offset: | |
| type: integer | |
| description: Number of releases skipped. | |
| limit: | |
| type: integer | |
| description: Maximum number of releases returned. | |
| releases: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Release" | |
| required: | |
| - realtime_start | |
| - realtime_end | |
| - order_by | |
| - sort_order | |
| - count | |
| - offset | |
| - limit | |
| - releases | |
| SeriesSearchResponse: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| order_by: | |
| type: string | |
| description: The attribute series are ordered by. | |
| sort_order: | |
| type: string | |
| enum: [asc, desc] | |
| description: The order results are sorted in. | |
| count: | |
| type: integer | |
| description: Total number of series matching the search criteria. | |
| offset: | |
| type: integer | |
| description: Number of series skipped. | |
| limit: | |
| type: integer | |
| description: Maximum number of series returned. | |
| seriess: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Series" | |
| required: | |
| - realtime_start | |
| - realtime_end | |
| - order_by | |
| - sort_order | |
| - count | |
| - offset | |
| - limit | |
| - seriess | |
| CategoryResponse: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| categories: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Category" | |
| required: | |
| - realtime_start | |
| - realtime_end | |
| - categories | |
| CategoriesResponse: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| categories: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Category" | |
| required: | |
| - realtime_start | |
| - realtime_end | |
| - categories | |
| Category: | |
| type: object | |
| properties: | |
| id: | |
| type: integer | |
| description: Unique identifier of the category. | |
| name: | |
| type: string | |
| description: Name of the category. | |
| parent_id: | |
| type: integer | |
| description: ID of the parent category. | |
| notes: | |
| type: string | |
| description: Additional notes about the category. | |
| required: | |
| - id | |
| - name | |
| - parent_id | |
| TagsResponse: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| tags: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Tag" | |
| required: | |
| - realtime_start | |
| - realtime_end | |
| - tags | |
| Tag: | |
| type: object | |
| properties: | |
| id: | |
| type: integer | |
| description: Unique identifier of the tag. | |
| name: | |
| type: string | |
| description: Name of the tag. | |
| group_id: | |
| type: integer | |
| description: ID of the tag group. | |
| series_count: | |
| type: integer | |
| description: Number of series associated with the tag. | |
| popularity: | |
| type: integer | |
| description: Popularity score of the tag. | |
| created: | |
| type: string | |
| format: date-time | |
| description: Date and time the tag was created. | |
| required: | |
| - id | |
| - name | |
| - group_id | |
| - series_count | |
| - popularity | |
| - created | |
| ReleaseDatesResponse: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| release_dates: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/ReleaseDate" | |
| required: | |
| - realtime_start | |
| - realtime_end | |
| - release_dates | |
| ReleaseDate: | |
| type: object | |
| properties: | |
| release_date: | |
| type: string | |
| format: date | |
| description: Date of the release. | |
| release_id: | |
| type: integer | |
| description: ID of the release. | |
| release_name: | |
| type: string | |
| description: Name of the release. | |
| required: | |
| - release_date | |
| - release_id | |
| - release_name | |
| SourcesResponse: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| sources: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Source" | |
| required: | |
| - realtime_start | |
| - realtime_end | |
| - sources | |
| Source: | |
| type: object | |
| properties: | |
| id: | |
| type: integer | |
| description: Unique identifier of the source. | |
| name: | |
| type: string | |
| description: Name of the source. | |
| link: | |
| type: string | |
| format: uri | |
| description: URL for more information about the source. | |
| required: | |
| - id | |
| - name | |
| - link | |
| ReleaseTables: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| tables: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/ReleaseTable" | |
| required: | |
| - realtime_start | |
| - realtime_end | |
| - tables | |
| ReleaseTable: | |
| type: object | |
| properties: | |
| id: | |
| type: integer | |
| description: Unique identifier of the table. | |
| name: | |
| type: string | |
| description: Name of the table. | |
| description: | |
| type: string | |
| description: Description of the table. | |
| frequency: | |
| type: string | |
| description: Frequency of the data in the table. | |
| start_date: | |
| type: string | |
| format: date | |
| description: Start date of the table. | |
| end_date: | |
| type: string | |
| format: date | |
| description: End date of the table. | |
| data: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/TableData" | |
| required: | |
| - id | |
| - name | |
| - description | |
| - frequency | |
| - start_date | |
| - end_date | |
| - data | |
| TableData: | |
| type: object | |
| properties: | |
| date: | |
| type: string | |
| format: date | |
| description: Date of the data. | |
| value: | |
| type: string | |
| description: Value of the data. | |
| required: | |
| - date | |
| - value | |
| VintageDatesResponse: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| vintage_dates: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/VintageDate" | |
| required: | |
| - realtime_start | |
| - realtime_end | |
| - vintage_dates | |
| VintageDate: | |
| type: object | |
| properties: | |
| vintage_date: | |
| type: string | |
| format: date | |
| description: Date of the vintage. | |
| release_id: | |
| type: integer | |
| description: ID of the release. | |
| release_name: | |
| type: string | |
| description: Name of the release. | |
| required: | |
| - vintage_date | |
| - release_id | |
| - release_name | |
| SourceResponse: | |
| type: object | |
| properties: | |
| realtime_start: | |
| type: string | |
| format: date | |
| realtime_end: | |
| type: string | |
| format: date | |
| source: | |
| type: object | |
| $ref: "#/components/schemas/Source" | |
| required: | |
| - realtime_start | |
| - realtime_end | |
| - source |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment