Month: April 2011

Federal Reserve Bank Financial Data Service

Edit:  Microsoft has discontinued the DataMarket program.  We are working to re-establish this service.

Your satisfaction is our number one priority.  Please use the contact us for support inquiries.

Federal Reserve Bank Financial Data Service

Documentation

Contents

  1. Data Description
  2. Primary Entities
  3. Lookup Entities
  4. Entity Diagram

Data Description

The Federal Reserve Bank Financial Data Service is a concise and readily usable form of the Statistics, Historical Data, Surveys, and Reports published in flat file format by the U.S. Federal Reserve Bank.  The Federal Reserve Bank Financial Data Service provides data search and retrieval across the full set of over 100,000 “SERIES” reports and over 8.7 million data points. Such comprehensive functionality like this is not provided by the Federal Reserve Bank.

  • The hierarchy of the data has four levels.Statistical Release: Major divisions of financial and ecomomic information. | Data Sets: A grouping category wherein each Series uses the same attributes set. | Series: Equivalent to a “Report”, each with a unique set of values applied to the attributes. | Observations: “The Data” for a particular SERIES.
  • Each hierarchy level adds a respesentive key for that level.Statistical Release: respesentive key = SR_ID | Data Sets: respesentive key = DataSet_ID | Series: respesentive key = SERIES_ID | Observations: respesentive key = OBS_ID
  • Record sets at each level are identified by the parent keys in the hierarchy.Statistical Release: record set identifier = (N/A for this top level) | Data Sets: record set identifier = SR_ID | Series: record set identifier = SR_ID & DataSet_ID | Observations: record set identifier = SR_ID, DataSet_ID, & SERIES_ID
  • Unique records at each level are identified by ALL keys down through the hierarchy to that level.Statistical Release: unique record identifier = SR_ID | Data Sets: unique record identifier = SR_ID & DataSet_ID | Series: unique record identifier = SR_ID, DataSet_ID, & SERIES_ID | Observations: unique record identifier = SR_ID, DataSet_ID, SERIES_ID, & OBS_ID
  • Except for Series, there is only one OData Entity for each level. Due to the varying attribute sets among Series, the lookup table SERIES_ATTRIBUTES provides attribute details for a particular Series. The intended user interface is a drill down through the hierarchy to identify the key set SR_ID, DataSet_ID, & SERIES_ID to then query OBSERVATIONS for all observation rows for a SERIES. Users should be able to retrieve a unique record at any level in the hierarchy by also specifiying optional parameters for that entity. All result sets returned to the user should include all entity properties (columns).

Top

Primary Entities

  • [STATISTICAL_RELEASES]:

    Top level, lists details of each Statistical Release

    • Query Keys
      1. “SR_ID”, int, optional. . . noramlly not required, result set is small (12 rows currently)
    • Columns Returned . . .
      • SR_ID . . . key identifier
      • NAME
      • DESCRIPTION
      • DATE
    • Use . . . Primary purpose is to identify “SR_ID” for drilldown to DATASETS.
  • [DATASETS]:

    Second level, “label” for grouping SERIES having the same SERIES_ATTRIBUTES.

    • Query Keys
      1. “SR_ID”, int, optional . . . noramlly not required, result set is small (35 rows currently)
      2. “DataSet_ID”, int, optional . . . noramlly not required, result set is small (35 rows currently)
    • Columns Returned . . .
      • SR_ID . . . key identifier
      • DataSet_ID . . . key identifier
      • DATASET . . . identification abbreviation
      • DATASET_DESCRIPTION
      • SERIES_COUNT . . . number of series within the DATASET
    • Use . . . Primary purpose is to identify “SR_ID” and “DataSet_ID” for drilldown to SERIES. Take note of the SERIES_COUNT column.
  • [SERIES]:

    Third Level, lists details, e.g. SERIES_NAME, DESCRIPTION, etc.

    • Query Keys
      1. “SR_ID”, int, required.
      2. “DataSet_ID”, int, required.
      3. “SERIES_ID”, int, optional.
    • Columns Returned . . .
      • SR_ID . . . key identifier
      • DataSet_ID . . . key identifier
      • SERIES_ID . . . key identifier
      • DATASET . . . identification abbreviation
      • SERIES_NAME
      • DESCRIPTION
      • FREQUENCY . . . data observation frequency, e.g. daily, monthly, etc.
      • RECORD_COUNT . . . number of observations
    • Use . . . Primary purpose is to identify “SR_ID”, “DataSet_ID”, AND “SERIES_ID” for drilldown to OBSERVATIONS(the data).
  • [OBSERVATIONS]:

    Fourth Level, lists the actual data.

    • Query Keys
      1. “SR_ID”, int, required.
      2. “DataSet_ID”, int, required.
      3. “SERIES_ID”, int, required.
      4. “OBS_ID”, int, optional.
    • Columns Returned . . .
      • SR_ID . . . key identifier
      • DataSet_ID . . . key identifier
      • SERIES_ID . . . key identifier
      • OBS_ID . . . key identifier
      • OBS_STATUS . . . e.g. A (normal), NA (not available)
      • OBS_VALUE
      • TIME_PERIOD

      SR_ID, NAME, DESCRIPTION, DATE.

    • Use . . . pulls the actual data for a SERIES.

Top

Lookup Entities

  • [SERIES_ATTRIBUTES]:

    Third Level, lookup “Helper” table with SERIES specific attributes/value pairs.lists details, e.g. SERIES_NAME, DESCRIPTION, etc.

    • Query Keys
      1. “SR_ID”, int, required.
      2. “DataSet_ID”, int, required.
      3. “SERIES_ID”, int, required.
    • Columns Returned . . .
      • SR_ID . . . key identifier
      • DataSet_ID . . . key identifier
      • SERIES_ID . . . key identifier
      • ATTRIBUTE_ID . . . key identifer
      • ATTRIBUTE . . . e.g. UNIT_MULT
      • ATTRIBUTE_DESCRIPTION
      • ATTRIBUTE_VALUE . . . e.g. 1000000 (millions)
      • ATTRIBUTE_VALUE_DESCRIPTION
    • Use . . . Primary purpose is to identify a SERIES’ attributes, e.g. Series Name, Currency, Frequency code list, Loan type, etc.

Top

Entity Diagram

FRB_SR Entity Diagram

Top

Copyright © 2011-2017, MacroTrenz Corp., All rights reserved.

U.S Bank Financial Condition and Performance Data Service


Your satisfaction is our number one priority.  Please contact us for support inquiries.

U.S Bank Financial Condition and Performance Data Service

Documentation

Contents

  1. Data Description
  2. Function Imports
  3. Entity Diagram

Data Description

The U.S Bank Financial Condition and Performance Data Service publishes, in a concise and readily usable data format, the regulatory reports, financial data, and structural information for FDIC-insured bank and thrift institutions published by the Federal Financial Institutions Examinations Council (FFIEC). The earliest data provided is from March 31, 2001. The U.S Bank Financial Condition and Performance Data Service provides data search and retrieval across the full set of over 350,000 quarterly Bank Call and Uniform Bank Performance reports representing over one billion data points. In addition, individual MDR element data can be retrieved across banks and reporting periods.

Top

Function Imports

      • [GET_REPORTING_PERIODS]:
        • Query Keys
          1. None.
        • Columns Returned . . .
          • PERIOD_ID
        • Use . . . Returns a list of all quarterly reporting period identifiers in the format YYYYMMDD.
        • Example URL Query: GET_REPORTING_PERIODS
      • [GET_BANK_LOOKUP]:
        • Query Keys
          1. “PERIOD_ID”, int, required . . . reporting period in the format YYYYMMDD.
          2. “SEARCH_SNIPPET”, string(10 characters max, alphanumeric only), required . . . searches for string in these bank information fields in this order:
            1. Name
            2. Address
            3. City
            4. State
            5. IDRSSD (FFIEC Bank Identifier)
            6. FDIC Certificate Number
            7. OCC Charter Number
            8. OTS Docket Number
            9. ABA Routing Number
            10. ZIP Code
        • Columns Returned . . .
          • PERIOD_ID . . . reporting period identifier
          • ID_RSSD . . . FFIEC bank identifier
          • FDICCertNumber . . . FDIC Certificate Number
          • OCCChartNumber . . . OCC Charter Number
          • OTSDockNumber . . . OTS Docket Number
          • PrimaryABARoutNumber . . . ABA Routing Number
          • Name . . . bank name
          • Address . . . bank address
          • City . . . bank city
          • State . . . bank state
          • ZIP . . . zip code
        • Use . . . identify individual bank/branch information and address(es) .
        • Example URL Queries:
          1. GET_BANK_LOOKUP?PERIOD_ID=20111231&SEARCH_SNIPPET=’hancock’
          2. GET_BANK_LOOKUP?PERIOD_ID=20111231&SEARCH_SNIPPET=’10057′
      • [GET_REPORT_CALL]:
        • Query Keys
          1. “ID_RSSD”, int, required.
          2. “PERIOD_ID”, int, required . . . reporting period in the format YYYYMMDD.
        • Columns Returned . . .
          • ID_RSSD . . . FFIEC bank identifier
          • REPORT_DATE . . . reporting period date
          • ENTRY . . . report line item, e.g. “section”, “subsection”, “blankline”, MDR element name
          • ENTRY_TYPE . . . report line item type, e.g. fact, credit, debit
          • ENTRY_PERIOD . . . report line item time span type, e.g. duration, instant, null for fact ENTRY_TYPE
          • ENTRY_STARTDATE . . . report line item time span start
          • ENTRY_ENDDATE . . . report line item time span end
          • UNIT_TYPE . . . classification of the report line item VALUE, e.g. USD
          • DECIMALS . . . number of decimal digits in the report line item VALUE
          • VALUE . . . the report line item datum
          • HEADER_LINE . . . the report line item description
          • HEADER_COLUMN . . . the report line item column description
          • SCHEDULE . . . report of condition or report of income schedule identifier
          • SCHEDULE_LINE . . . report of condition or report of income schedule line identifier
          • SCHEDULE_COL . . . report of condition or report of income column identifier
          • USE . . . the report line item usage requirement, e.g. required, optional
          • LEVEL . . . formatting information indicating the level of indentation for the report line
          • SORT . . . the report line item sort key
        • Use . . . returns the full CALL REPORT, in a concise and readily usable data format, for the specified bank and reporting period.
        • Example Query: GET_REPORT_CALL?ID_RSSD=37&PERIOD_ID=20111231
      • [GET_REPORT_UBPR]:
        • Query Keys
          1. “ID_RSSD”, int, required.
          2. “PERIOD_ID”, int, required . . . reporting period in the format YYYYMMDD.
        • Columns Returned . . .
          • ID_RSSD . . . FFIEC bank identifier
          • REPORT_DATE . . . reporting period date
          • REPORT_PAGE . . . report page name
          • REPORT_LINE . . . the report line item description
          • ENTRY . . . report line item, e.g. “section”, “subsection”, “page”, “blankline”, MDR element name
          • ENTRY_TYPE . . . report line item type, e.g. fact, credit, debit
          • ENTRY_PERIOD . . . report line item time span type, e.g. duration, instant, null for fact ENTRY_TYPE
          • ENTRY_STARTDATE . . . report line item time span start
          • ENTRY_ENDDATE . . . report line item time span end
          • UNIT_TYPE . . . classification of the report line item VALUE, e.g. USD
          • DECIMALS . . . number of decimal digits in the report line item VALUE
          • VALUE . . . the report line item datum
          • USE . . . the report line item usage requirement, e.g. required, optional
          • LEVEL . . . formatting information indicating the level of indentation for the report line
          • SORT . . . the report line item sort key
        • Use . . . returns the full UBPR REPORT, in a concise and readily usable data format, for the specified bank and reporting period.
        • Example Query: GET_REPORT_UBPR?ID_RSSD=37&PERIOD_ID=20111231
      • [GET_RAW_DATA]:
        • Query Keys . . . NOTE: while each query key is optional, at least one must must be specified to get results.
          1. “ID_RSSD”, int, optional.
          2. “PERIOD_ID”, int, optional . . . reporting period in the format YYYYMMDD.
          3. “ELEMENT_NAME”, string(8 characters max, alphanumeric only), optional.
        • Columns Returned . . .
          • ID_RSSD . . . FFIEC bank identifier
          • PERIOD_ID . . . reporting period date
          • ELEMENT_NAME . . . MDR element name, e.g. “RIAD4150”, “UBPRE001”
          • ENTRY_STARTDATE . . . report line item time span start
          • ENTRY_ENDDATE . . . report line item time span end
          • UNIT_TYPE . . . classification of the report line item VALUE, e.g. USD
          • DECIMALS . . . number of decimal digits in the report line item VALUE
          • VALUE . . . the report line item datum
        • Use . . . returns raw data in a concise and readily usable format.
        • Example URL Query using keys: GET_RAW_DATA?ID_RSSD=37&PERIOD_ID=20111231

Top

Entity Diagram

FFIEC Entity Diagram

Top

Copyright © 2011-2017, MacroTrenz Corp., All rights reserved.