Hedge Fund Monitor
Series Information: Series Search
https://data.financialresearch.gov/hf/v1/metadata/search
Description
Returns a list of data sets and series that contain field values that match the given search query. The results are returned with the following fields:
- mnemonic: unique identifier for the series
- dataset: identifier for the data set that the series is a part of
- field: the metadata field that satisfies the search query
- value: the value of the field that satisfies the search query
- type: format of the data within the field
If the metadata is at the data set level, then "mnemonic" will be "none".
Parameters
- query - The value for which you want to search. * and ? are supported. This parameter is required.
Examples
Call:https://data.financialresearch.gov/hf/v1/metadata/search?query=Fund*Output:
[
{
"value": "Fund of funds: count of fund open positions (median fund)",
"dataset": "fpf",
"mnemonic": "FPF-ALLQHF_FOF_OPENPOSITIONS_MEDIAN",
"field": "description/name",
"type": "str"
},
{
"value": "Fund of funds: unencumbered cash ratio (weighted average by gross assets)",
"dataset": "fpf",
"mnemonic": "FPF-STRATEGY_FOF_CASHRATIO_GAVWMEAN",
"field": "description/name",
"type": "str"
},
{
"value": "Fund of funds: unencumbered cash ratio (weighted average by net assets)",
"dataset": "fpf",
"mnemonic": "FPF-STRATEGY_FOF_CASHRATIO_NAVWMEAN",
"field": "description/name",
"type": "str"
},
...
]
Call:
https://data.financialresearch.gov/hf/v1/metadata/search?query=*credit*Output:
[
{
"value": "FPF-ALLQHF_CREDIT_OPENPOSITIONS_MEDIAN",
"dataset": "fpf",
"mnemonic": "FPF-ALLQHF_CREDIT_OPENPOSITIONS_MEDIAN",
"field": "mnemonic",
"type": "str"
},
{
"value": "Credit strategy funds: count of fund open positions (median fund)",
"dataset": "fpf",
"mnemonic": "FPF-ALLQHF_CREDIT_OPENPOSITIONS_MEDIAN",
"field": "description/name",
"type": "str"
},
{
"value": "Median number of open positions for credit strategy funds",
"dataset": "fpf",
"mnemonic": "FPF-ALLQHF_CREDIT_OPENPOSITIONS_MEDIAN",
"field": "description/description",
"type": "str"
},
...
]
Version
This API endpoint is available in the following versions of the OFR API.
1