Hedge Fund Monitor

Overview:

The Hedge Fund Monitor (HFM) application programming interface (API) allows a remote application to query the Office of Financial Research for data without the need for a human intermediary to download data manually. While some API calls might be used every day, others are intended for use when setting up a remote application for a periodic refresh.

We have provided this open interface for public use. This API does not require tokens or registration, so feel free to use it immediately.

Base URL:

https://data.financialresearch.gov/hf/

Version

You must include the API version you wish to reference in your call as part of the URL path. 

https://data.financialresearch.gov/hf/v1
Currently the HFM API is on version: v1.

Technical Assertions & Guidelines

Protocols

All responses shall utilize HTTPS (HTTP + Secure Socket Layer).

Response Formats

All API output will be in JSON format.

Get Series Information

The following retrieve the metadata attached to each specified series.

  • /metadata/mnemonics/ - Retrieves all series as unique identifiers referred to as mnemonics.
  • /metadata/query/ - Retrieves the information for a specified series.
  • /metadata/search/ - Retrieves a list of series with identifying information that matches a query condition.

Get Series Data

The following retrieve the data for specified series.

Get Series Information & Data

The following retrieve the metadata and data for specified series.

  • /series/full/ - Retrieves the information and data for a single series.
  • /series/multifull/ - Retrieves the information and data for a group of series.
  • /series/dataset/ - Retrieves the information and data for all series in a specified data set.
  • /categories/ - Returns a csv file containing the data for a category.

API Use Cases

The HFM API can be leveraged in a multitude of ways; for specific use cases, please see examples of API Requests and Responses.