Get Releases Dates

{"methods":[{"methodType":"GET","methodDesc":"Get release dates for all releases of economic data.","requestParams":[{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: first day of current year."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: 9999-12-31."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-1000, default: 1000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"order_by","type":"string","required":false,"description":"One of: release_date, release_id, release_name. Default: release_date."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: desc."},{"name":"include_release_dates_with_no_data","type":"string","required":false,"description":"true or false. Default: false."}],"responseParams":[{"name":"release_dates","type":"array","description":"Array of release_date objects with release_id, release_name, date."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->

GET https://api.aisa.one/apis/v1/fred/releases/dates

Get Releases Dates

cURL

curl --request GET \
  --url https://api.aisa.one/apis/v1/fred/releases/dates \
  --header 'Authorization: Bearer <token>'

200

<release_dates realtime_start="2013-01-01" realtime_end="9999-12-31" order_by="release_date" sort_order="desc" count="1129" offset="0" limit="1000">
    <release_date release_id="9" release_name="Advance Monthly Sales for Retail and Food Services">2013-08-13</release_date>
    <release_date release_id="262" release_name="Failures and Assistance Transactions">2013-08-13</release_date>
    <release_date release_id="25" release_name="Manufacturing and Trade Inventories and Sales">2013-08-13</release_date>
    <release_date release_id="92" release_name="Selected Real Retail Sales Series">2013-08-13</release_date>
    <release_date release_id="188" release_name="U.S. Import and Export Price Indexes">2013-08-13</release_date>
    <release_date release_id="183" release_name="Gasoline and Diesel Fuel Update">2013-08-12</release_date>
    <release_date release_id="18" release_name="H.15 Selected Interest Rates">2013-08-12</release_date>
    <release_date release_id="269" release_name="National Accounts of Japan">2013-08-12</release_date>
    <release_date release_id="71" release_name="Weekly Treasury Inflation-Indexed Securities">2013-08-12</release_date>
    <release_date release_id="122" release_name="H.4.1 Factors Affecting Reserve Balances (data not included in press release)">2013-08-09</release_date>
    <release_date release_id="22" release_name="H.8 Assets and Liabilities of Commercial Banks in the United States">2013-08-09</release_date>
    <release_date release_id="63" release_name="M2 Related Series">2013-08-09</release_date>
    <release_date release_id="61" release_name="Money Zero Maturity (MZM)">2013-08-09</release_date>
    <release_date release_id="236" release_name="Monthly Housing Affordability Index">2013-08-09</release_date>
    <release_date release_id="78" release_name="St. Louis Monthly Reserves and Monetary Base">2013-08-09</release_date>
    <release_date release_id="105" release_name="St. Louis Weekly Reserves and Monetary Base">2013-08-09</release_date>
    <release_date release_id="255" release_name="Bank Rate Monitor's Weekly Survey">2013-08-08</release_date>
    <release_date release_id="53" release_name="Gross Domestic Product">2013-08-08</release_date>
    <release_date release_id="19" release_name="H.3 Aggregate Reserves of Depository Institutions and the Monetary Base">2013-08-08</release_date>
    <release_date release_id="283" release_name="H.3 Aggregate Reserves of Depository Institutions and the Monetary Base (data not included in press release)">2013-08-08</release_date>
    ...
</release_dates>

Request contract

• Method and path: GET /apis/v1/fred/releases/dates
• Availability: enabled
• Request URL template: https://api.aisa.one/apis/v1/fred/releases/dates
• file_type: query; optional
• include_release_dates_with_no_data: query; optional
• limit: query; optional
• offset: query; optional
• order_by: query; optional
• realtime_end: query; optional
• realtime_start: query; optional
• sort_order: query; optional
• Runtime facts: 99b84812775a5b511e5b561db33dbfe37ed3954afbc7b30caf10377dcd683c23

Complete OpenAPI definition

Effective request and pricing declaration (including authentication and referenced schemas):

{
  "operationId": "any_fred_apis_v1_fred_releases_dates",
  "method": "GET",
  "path": "/apis/v1/fred/releases/dates",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "name": "file_type",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "xml",
          "json"
        ],
        "default": "xml"
      },
      "description": "A key or file extension that indicates the type of file to send.\nstring, optional, default: xml\nOne 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.\nxml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json.",
      "x-aisa-reference-declarations": [
        "string, optional, default: xml",
        "One of the following values: 'xml', 'json'"
      ]
    },
    {
      "name": "include_release_dates_with_no_data",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ],
        "default": "false"
      },
      "description": "Determines whether release dates with no data available are returned. The defalut value 'false' excludes release dates that do not have data. In particular, this excludes future release dates which may be available in the FRED release calendar or the ALFRED release calendar .\nIf include_release_dates_with_no_data is set to true, the XML tag release_date has an extra attribute release_last_updated that can be compared to the release date to determine if data has been updated.\nOne of the following strings: 'true', 'false'.\noptional, default: false",
      "x-aisa-reference-declarations": [
        "One of the following strings: 'true', 'false'.",
        "optional, default: false"
      ]
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 1000,
        "default": 1000
      },
      "description": "The maximum number of results to return.\ninteger between 1 and 1000, optional, default: 1000",
      "x-aisa-reference-declarations": [
        "integer between 1 and 1000, optional, default: 1000"
      ]
    },
    {
      "name": "offset",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 0,
        "default": 0
      },
      "description": "non-negative integer, optional, default: 0",
      "x-aisa-reference-declarations": [
        "non-negative integer, optional, default: 0"
      ]
    },
    {
      "name": "order_by",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "release_date",
          "release_id",
          "release_name"
        ],
        "default": "release_date"
      },
      "description": "Order results by values of the specified attribute.\nOne of the following strings: 'release_date', 'release_id', 'release_name'.\noptional, default: release_date",
      "x-aisa-reference-declarations": [
        "One of the following strings: 'release_date', 'release_id', 'release_name'.",
        "optional, default: release_date"
      ]
    },
    {
      "name": "realtime_end",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "format": "date",
        "default": "9999-12-31"
      },
      "description": "The end of the real-time period. For more information, see Real-Time Periods .\nYYYY-MM-DD formatted string, optional, default: 9999-12-31 (latest available)",
      "x-aisa-reference-declarations": [
        "YYYY-MM-DD formatted string, optional, default: 9999-12-31 (latest available)"
      ]
    },
    {
      "name": "realtime_start",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "format": "date"
      },
      "description": "The start of the real-time period. For more information, see Real-Time Periods .\nYYYY-MM-DD formatted string, optional, default: First day of the current year",
      "x-aisa-reference-declarations": [
        "YYYY-MM-DD formatted string, optional, default: First day of the current year"
      ]
    },
    {
      "name": "sort_order",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "asc",
          "desc"
        ],
        "default": "desc"
      },
      "description": "Sort results is ascending or descending release date order.\nOne of the following strings: 'asc', 'desc'.\noptional, default: desc",
      "x-aisa-reference-declarations": [
        "One of the following strings: 'asc', 'desc'.",
        "optional, default: desc"
      ]
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "cost_contract": "fixed_success",
    "customer_pricing": "fixed_success",
    "default_request_estimate_usd": 1e-05,
    "estimate_source": "profile_seed",
    "evidence_source": "request_snapshot"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}

Cost and request rules

Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ.

Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

• Default request reference estimate (USD): 1e-05
• Cost contract: fixed_success
• Settlement evidence source: request_snapshot

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

file_type · enum<string> · default: xml

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. xml = Extensible Markup Language. The HTTP Content-Type is text/xml. json = JavaScript Object Notation. The HTTP Content-Type is application/json.

Available options: xml, json

include_release_dates_with_no_data · enum<string> · default: false

Determines whether release dates with no data available are returned. The defalut value 'false' excludes release dates that do not have data. In particular, this excludes future release dates which may be available in the FRED release calendar or the ALFRED release calendar . If include_release_dates_with_no_data is set to true, the XML tag release_date has an extra attribute release_last_updated that can be compared to the release date to determine if data has been updated. One of the following strings: 'true', 'false'. optional, default: false

Available options: true, false

limit · integer · default: 1000

The maximum number of results to return. integer between 1 and 1000, optional, default: 1000

Required range: 1 <= x <= 1000

offset · integer · default: 0

non-negative integer, optional, default: 0

Required range: x >= 0

order_by · enum<string> · default: release_date

Order results by values of the specified attribute. One of the following strings: 'release_date', 'release_id', 'release_name'. optional, default: release_date

Available options: release_date, release_id, release_name

realtime_end · string<date> · default: 9999-12-31

The end of the real-time period. For more information, see Real-Time Periods . YYYY-MM-DD formatted string, optional, default: 9999-12-31 (latest available)

realtime_start · string<date>

The start of the real-time period. For more information, see Real-Time Periods . YYYY-MM-DD formatted string, optional, default: First day of the current year

sort_order · enum<string> · default: desc

Sort results is ascending or descending release date order. One of the following strings: 'asc', 'desc'. optional, default: desc

Available options: asc, desc

Response

200

text/xml

Official representation and examples only; no complete response schema is declared.