FRED — Get Series in Release
fred_get_fred_release_seriesFRED — Get Series in Release Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 | |
| offset | No | non-negative integer, optional, default: 0 | |
| order_by | No | Order results by values of the specified attribute. One of the following strings: 'series_id', 'title', 'units', 'frequency', 'seasonal_adjustment', 'realtime_start', 'realtime_end', 'last_updated', 'observation_start', 'observation_end', 'popularity','group_popularity'. optional, default: series_id | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| tag_names | No | A semicolon delimited list of tag names that series match all of. String, optional, no filtering by tags by default Example value: 'japan;imports'. Filter results to series having both tags 'japan' and 'imports'. See the related request fred/tags. | |
| release_id | Yes | The id for a release. integer, required | |
| sort_order | No | Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| filter_value | No | The value of the filter_variable attribute to filter results by. String, optional, no filter by default | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods. YYYY-MM-DD formatted string, optional, default: today's date | |
| filter_variable | No | The attribute to filter results by. One of the following strings: 'frequency', 'units', 'seasonal_adjustment'. optional, no filter by default | |
| exclude_tag_names | No | A semicolon delimited list of tag names that series match none of. String, optional, no filtering by tags by default. Example value: 'imports;services'. Filter results to series having neither tag 'imports' nor tag 'services'. Parameter exclude_tag_names requires that parameter tag_names also be set to limit the number of matching series. |