Short-term Funding Monitor - API Series Spread

Short-term funding markets are the core of liquidity and maturity transformation in financial markets. They provide financing for financial institutions, serve as alternatives to deposits for cash investors, and can be used to obtain securities. However, as unavoidable consequences of their functions, these critical markets are vulnerable to disruptions. Problems faced by financial institutions or other parts of the financial system often appear as stresses in short-term funding markets. As part of the Office of Financial Research’s mission to promote and monitor financial stability, the OFR collects a variety of data on these markets. The Short-term Funding Monitor presents these data and places them in context with other data sources.

Series Data: Series Spread

https://data.financialresearch.gov/v1/calc/spread

Description

Returns the difference between the data points of two specified series. It will compute the spread of the aggregation subseries by calculating the difference between the first mnemonic (x) and the second mnemonic (y).

Parameters

  • x - The mnemonic (unique identifier) for the first series that you want to use as the base of the calculation. This parameter is required
  • y - The mnemonic (unique identifier) for the second series that will be subtracted from x. This parameter is required
  • start_date - First date in "YYYY-MM-DD" format for which you want to receive data. If no start_date is given, "1901-01-01" is used.
  • end_date - Last date in "YYYY-MM-DD" format for which you want to receive data. If no end_date is given, today's date is used.
  • periodicity - Converts the series to the given periodicity. Available values are:
    Value Description
    A Calendar Year End
    AS Calendar Year Start
    D Daily
    M Calendar Month End
    MS Calendar Month Start
    W Weekly (Sunday Start)
    B Business Day (Weekday)
    BM Business Month End
    BMS Business Month Start
    Q Quarter End
    BQ Business Quarter End
    QS Quarter Start
    BQS Business Quarter Start
    BA Business Year End
    BAS Business Year Start
  • how - How to calculate the value for the given periodicity. By default the last value in that period is given. Available values are:
    Value Description
    first First Value of the Period
    last Last Value of the Period
    mean Mean Value for the Period
    median Median Value for the Period
    sum Sum of All Values in the Period
  • remove_nulls - If this parameter is set to "true" all nulls in the series will be removed.
  • time_format - The format for the dates in the series. By default they are returned as strings in the format: YYYY-MM-DD. Available values are:
    Value Description
    date Returned as a string in the format: YYYY-MM-DD
    ms Returned as an integer of the number of milliseconds since epoch (1970-01-01)

Examples

Call: 
https://data.financialresearch.gov/v1/calc/spread?x=REPO-GCF_AR_G30-P&y=REPO-TRI_AR_AG-P
Output: 
[
  [
    "2020-01-02",
    0.15
  ],
  [
    "2020-03-03",
    -0.37
  ],
  [
    "2020-03-12",
    -0.29
  ],
  [
    "2020-04-01",
    0.6
  ]
]

Version

This API endpoint is available in the following versions of the OFR API.

1