Hedge Fund Monitor

Series Information: Single Series Query

https://data.financialresearch.gov/hf/v1/metadata/query

Description

Returns specific metadata for the given mnemonic. Series metadata is organized into fields; some fields have subfields. If you do not specify the fields parameter, all the metadata for that mnemonic is returned. The metadata is returned as a single hash with the field names and their value.

Parameters

  • mnemonic - The mnemonic for which you want to retrieve metadata. This parameter is required.
  • fields - The fields you want to retrieve. You can retrieve multiple fields by separating them with commas. To access a subfield of a field use a / eg: release/long_name.

Examples

Call: 
https://data.financialresearch.gov/hf/v1/metadata/query?mnemonic=fpf-allqhf_cdsup250bps_p5
Output: 
{
    "mnemonic": "FPF-ALLQHF_CDSUP250BPS_P5",
    "description": {
        "vintage_approach": "Current vintage, as of last update",
        "vintage": "",
        "notes": "SEC Form PF question 42. Values represent the net effect, as a percent of net assets, of long minus short positions. ",
        "name": "Stress test: CDS spreads increase 250 basis points net impact on NAV (5th percentile fund)",
        "subsetting": "None",
        "subtype": "None",
        "description": "5th percentile net effect, as a percent of net assets, of CDS spreads increasing 250 bps"
    },
    "schedule": {
        "observation_period": "Quarterly",
        "seasonal_adjustment": "None",
        "observation_frequency": "Quarterly",
        "start_date": "2013-03-31",
        "last_update": ""
    },
  ...
}
Call: 
https://data.financialresearch.gov/hf/v1/metadata/query?mnemonic=fpf-allqhf_cdsup250bps_p5&fields=release/long_name
Output: 
{
    "release": {
        "long_name": "Hedge Fund Aggregated Statistics from SEC Form PF Filings"
    }
}

Version

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

1