US Board of Federal Reserve GraphQL Documentation
This documentation includes the GraphQL query and subscription specification for access to the US Board of Federal Reserve (US FED) data on our platform.
Terms of Service
API Endpoints
# Production Server for Queries:
https://api.beamapi.com/data/fundamentals/us/us_federal_reserve/v1/
# Production Server for Subscriptions:
wss://api.beamapi.com/data/fundamentals/us/us_federal_reserve/v1/ws
Headers
# Your API key from the dashboard. Must be included in all API calls. For websocket connections, this value is put in an initial on connection payload.
{"api-key": "<YOUR_TOKEN_HERE>"}Version
1
Queries
chgdel_series
Description
Charge-Off and Delinquency Rates on Loans and Leases at Commercial Banks
Response
Returns [CHGDELSeries!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterCHGDELSeries
|
Example
Query
query chgdel_series(
$offset: Int,
$filters: FilterCHGDELSeries
) {
chgdel_series(
offset: $offset,
filters: $filters
) {
component
currency
frequency
loan_type
long_description
rate_type
seasonal_adjustment
series_name
short_description
size_group
unit
unit_multiplier
}
}
Variables
{"offset": 987, "filters": FilterCHGDELSeries}
Response
{
"data": {
"chgdel_series": [
{
"component": "abc123",
"currency": "abc123",
"frequency": "xyz789",
"loan_type": "xyz789",
"long_description": "abc123",
"rate_type": "xyz789",
"seasonal_adjustment": "abc123",
"series_name": "abc123",
"short_description": "abc123",
"size_group": "xyz789",
"unit": "xyz789",
"unit_multiplier": 987.65
}
]
}
}
chgdel_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterCHGDELSeries
|
Example
Query
query chgdel_series_count($filters: FilterCHGDELSeries) {
chgdel_series_count(filters: $filters)
}
Variables
{"filters": FilterCHGDELSeries}
Response
{"data": {"chgdel_series_count": 987}}
cp_series
Description
Commercial Paper Rates and Outstanding
Response
Returns [CPSeries!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterCPSeries
|
Example
Query
query cp_series(
$offset: Int,
$filters: FilterCPSeries
) {
cp_series(
offset: $offset,
filters: $filters
) {
category
currency
frequency
long_description
maturity_range
maturity_term
rate_type
seasonal_adjustment
series_name
short_description
unit
unit_multiplier
volume_types
}
}
Variables
{"offset": 123, "filters": FilterCPSeries}
Response
{
"data": {
"cp_series": [
{
"category": "xyz789",
"currency": "xyz789",
"frequency": "abc123",
"long_description": "xyz789",
"maturity_range": "xyz789",
"maturity_term": "abc123",
"rate_type": "xyz789",
"seasonal_adjustment": "xyz789",
"series_name": "abc123",
"short_description": "xyz789",
"unit": "xyz789",
"unit_multiplier": 987.65,
"volume_types": "xyz789"
}
]
}
}
cp_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterCPSeries
|
Example
Query
query cp_series_count($filters: FilterCPSeries) {
cp_series_count(filters: $filters)
}
Variables
{"filters": FilterCPSeries}
Response
{"data": {"cp_series_count": 987}}
e2_series
Description
Survey of Terms of Business Lending
Response
Returns [E2Series!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterE2Series
|
Example
Query
query e2_series(
$offset: Int,
$filters: FilterE2Series
) {
e2_series(
offset: $offset,
filters: $filters
) {
base_rate_of_loan
commitment_status
currency
frequency
loan_characteristic
long_description
maturity_or_repricing_interval
panel
risk_rating
series_name
short_description
size_of_loan
summary_statistics
terms_set_before_survey_week
time_pricing_terms_were_set
unit
unit_multiplier
}
}
Variables
{"offset": 987, "filters": FilterE2Series}
Response
{
"data": {
"e2_series": [
{
"base_rate_of_loan": "abc123",
"commitment_status": "abc123",
"currency": "xyz789",
"frequency": "xyz789",
"loan_characteristic": "xyz789",
"long_description": "xyz789",
"maturity_or_repricing_interval": "abc123",
"panel": "xyz789",
"risk_rating": "xyz789",
"series_name": "xyz789",
"short_description": "abc123",
"size_of_loan": "xyz789",
"summary_statistics": "xyz789",
"terms_set_before_survey_week": "abc123",
"time_pricing_terms_were_set": "xyz789",
"unit": "xyz789",
"unit_multiplier": 123.45
}
]
}
}
e2_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterE2Series
|
Example
Query
query e2_series_count($filters: FilterE2Series) {
e2_series_count(filters: $filters)
}
Variables
{"filters": FilterE2Series}
Response
{"data": {"e2_series_count": 123}}
fomc_release
Description
Federal Open Market Committee (FOMC) Release and Target Rates. Use this endpoint for interest rate announcements from the federal reserve.
Response
Returns [FOMCRelease!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterFOMCRelease
|
Example
Query
query fomc_release(
$offset: Int,
$filters: FilterFOMCRelease
) {
fomc_release(
offset: $offset,
filters: $filters
) {
article
federal_funds_rate_target_range_high_end
federal_funds_rate_target_range_low_end
implementation_notes
interest_rate_paid_on_reserve_balances
press_release_guid
primary_credit_rate
pub_datetime
}
}
Variables
{"offset": 123, "filters": FilterFOMCRelease}
Response
{
"data": {
"fomc_release": [
{
"article": "xyz789",
"federal_funds_rate_target_range_high_end": 123.45,
"federal_funds_rate_target_range_low_end": 987.65,
"implementation_notes": "abc123",
"interest_rate_paid_on_reserve_balances": 123.45,
"press_release_guid": "abc123",
"primary_credit_rate": 987.65,
"pub_datetime": "2007-12-03T10:15:30Z"
}
]
}
}
fomc_release_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterFOMCRelease
|
Example
Query
query fomc_release_count($filters: FilterFOMCRelease) {
fomc_release_count(filters: $filters)
}
Variables
{"filters": FilterFOMCRelease}
Response
{"data": {"fomc_release_count": 987}}
for_series
Description
Household Debt Service and Financial Obligations Ratios
Response
Returns [FORSeries!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterFORSeries
|
Example
Query
query for_series(
$offset: Int,
$filters: FilterFORSeries
) {
for_series(
offset: $offset,
filters: $filters
) {
currency
debt
frequency
long_description
measure
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"offset": 123, "filters": FilterFORSeries}
Response
{
"data": {
"for_series": [
{
"currency": "xyz789",
"debt": "xyz789",
"frequency": "abc123",
"long_description": "abc123",
"measure": "xyz789",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "xyz789",
"unit_multiplier": 123.45
}
]
}
}
for_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterFORSeries
|
Example
Query
query for_series_count($filters: FilterFORSeries) {
for_series_count(filters: $filters)
}
Variables
{"filters": FilterFORSeries}
Response
{"data": {"for_series_count": 123}}
g17_series
Description
Industrial Production and Capacity Utilization
Response
Returns [G17Series!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterG17Series
|
Example
Query
query g17_series(
$offset: Int,
$filters: FilterG17Series
) {
g17_series(
offset: $offset,
filters: $filters
) {
currency
frequency
long_description
seasonal_adjustment
series_code
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"offset": 123, "filters": FilterG17Series}
Response
{
"data": {
"g17_series": [
{
"currency": "xyz789",
"frequency": "abc123",
"long_description": "xyz789",
"seasonal_adjustment": "xyz789",
"series_code": "abc123",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 123.45
}
]
}
}
g17_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterG17Series
|
Example
Query
query g17_series_count($filters: FilterG17Series) {
g17_series_count(filters: $filters)
}
Variables
{"filters": FilterG17Series}
Response
{"data": {"g17_series_count": 123}}
g19_series
Description
Consumer credit
Response
Returns [G19Series!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterG19Series
|
Example
Query
query g19_series(
$offset: Int,
$filters: FilterG19Series
) {
g19_series(
offset: $offset,
filters: $filters
) {
credit_type
currency
data_representation
frequency
holder
issuer
long_description
seasonal_adjustment
series_name
short_description
terms_of_credit
unit
unit_multiplier
}
}
Variables
{"offset": 987, "filters": FilterG19Series}
Response
{
"data": {
"g19_series": [
{
"credit_type": "abc123",
"currency": "abc123",
"data_representation": "xyz789",
"frequency": "abc123",
"holder": "xyz789",
"issuer": "xyz789",
"long_description": "xyz789",
"seasonal_adjustment": "abc123",
"series_name": "xyz789",
"short_description": "xyz789",
"terms_of_credit": "xyz789",
"unit": "abc123",
"unit_multiplier": 123.45
}
]
}
}
g19_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterG19Series
|
Example
Query
query g19_series_count($filters: FilterG19Series) {
g19_series_count(filters: $filters)
}
Variables
{"filters": FilterG19Series}
Response
{"data": {"g19_series_count": 123}}
g20_series
Description
Finance Companies
Response
Returns [G20Series!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterG20Series
|
Example
Query
query g20_series(
$offset: Int,
$filters: FilterG20Series
) {
g20_series(
offset: $offset,
filters: $filters
) {
asset_type
currency
data_representation
frequency
loan_terms
loan_type
long_description
seasonal_adjustment
series
series_category
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"offset": 123, "filters": FilterG20Series}
Response
{
"data": {
"g20_series": [
{
"asset_type": "abc123",
"currency": "abc123",
"data_representation": "xyz789",
"frequency": "abc123",
"loan_terms": "abc123",
"loan_type": "xyz789",
"long_description": "xyz789",
"seasonal_adjustment": "xyz789",
"series": "xyz789",
"series_category": "xyz789",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "xyz789",
"unit_multiplier": 987.65
}
]
}
}
g20_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterG20Series
|
Example
Query
query g20_series_count($filters: FilterG20Series) {
g20_series_count(filters: $filters)
}
Variables
{"filters": FilterG20Series}
Response
{"data": {"g20_series_count": 123}}
g5_h10_series
Description
Foreign Exchange Rates
Response
Returns [G5H10Series!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterG5H10Series
|
Example
Query
query g5_h10_series(
$offset: Int,
$filters: FilterG5H10Series
) {
g5_h10_series(
offset: $offset,
filters: $filters
) {
currency
currency_or_index_type
frequency
long_description
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"offset": 123, "filters": FilterG5H10Series}
Response
{
"data": {
"g5_h10_series": [
{
"currency": "xyz789",
"currency_or_index_type": "abc123",
"frequency": "xyz789",
"long_description": "abc123",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 123.45
}
]
}
}
g5_h10_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterG5H10Series
|
Example
Query
query g5_h10_series_count($filters: FilterG5H10Series) {
g5_h10_series_count(filters: $filters)
}
Variables
{"filters": FilterG5H10Series}
Response
{"data": {"g5_h10_series_count": 123}}
h15_series
Description
Selected Interest Rates
Response
Returns [H15Series!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterH15Series
|
Example
Query
query h15_series(
$offset: Int,
$filters: FilterH15Series
) {
h15_series(
offset: $offset,
filters: $filters
) {
currency
frequency
instrument
long_description
maturity
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"offset": 987, "filters": FilterH15Series}
Response
{
"data": {
"h15_series": [
{
"currency": "xyz789",
"frequency": "xyz789",
"instrument": "xyz789",
"long_description": "xyz789",
"maturity": "xyz789",
"series_name": "xyz789",
"short_description": "abc123",
"unit": "abc123",
"unit_multiplier": 987.65
}
]
}
}
h15_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterH15Series
|
Example
Query
query h15_series_count($filters: FilterH15Series) {
h15_series_count(filters: $filters)
}
Variables
{"filters": FilterH15Series}
Response
{"data": {"h15_series_count": 123}}
h3_series
Description
Aggregate Reserves of Depository Institutions and the Monetary Base
Response
Returns [H3Series!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterH3Series
|
Example
Query
query h3_series(
$offset: Int,
$filters: FilterH3Series
) {
h3_series(
offset: $offset,
filters: $filters
) {
currency
frequency
long_description
reserves
reserves_detail
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"offset": 987, "filters": FilterH3Series}
Response
{
"data": {
"h3_series": [
{
"currency": "abc123",
"frequency": "abc123",
"long_description": "abc123",
"reserves": "abc123",
"reserves_detail": "abc123",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "xyz789",
"unit_multiplier": 987.65
}
]
}
}
h3_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterH3Series
|
Example
Query
query h3_series_count($filters: FilterH3Series) {
h3_series_count(filters: $filters)
}
Variables
{"filters": FilterH3Series}
Response
{"data": {"h3_series_count": 987}}
h41_series
Description
Factors Affecting Reserve Balances
Response
Returns [H41Series!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterH41Series
|
Example
Query
query h41_series(
$offset: Int,
$filters: FilterH41Series
) {
h41_series(
offset: $offset,
filters: $filters
) {
currency
frequency
long_description
series_name
series_type
short_description
unit
unit_multiplier
}
}
Variables
{"offset": 987, "filters": FilterH41Series}
Response
{
"data": {
"h41_series": [
{
"currency": "abc123",
"frequency": "xyz789",
"long_description": "xyz789",
"series_name": "xyz789",
"series_type": "xyz789",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 123.45
}
]
}
}
h41_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterH41Series
|
Example
Query
query h41_series_count($filters: FilterH41Series) {
h41_series_count(filters: $filters)
}
Variables
{"filters": FilterH41Series}
Response
{"data": {"h41_series_count": 987}}
h6_series
Description
Money Stock Measures
Response
Returns [H6Series!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterH6Series
|
Example
Query
query h6_series(
$offset: Int,
$filters: FilterH6Series
) {
h6_series(
offset: $offset,
filters: $filters
) {
currency
frequency
long_description
seasonal_adjustment
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"offset": 987, "filters": FilterH6Series}
Response
{
"data": {
"h6_series": [
{
"currency": "xyz789",
"frequency": "abc123",
"long_description": "abc123",
"seasonal_adjustment": "abc123",
"series_name": "abc123",
"short_description": "abc123",
"unit": "xyz789",
"unit_multiplier": 987.65
}
]
}
}
h6_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterH6Series
|
Example
Query
query h6_series_count($filters: FilterH6Series) {
h6_series_count(filters: $filters)
}
Variables
{"filters": FilterH6Series}
Response
{"data": {"h6_series_count": 123}}
h8_series
Description
Assets and Liabilities of Commercial Banks in the U.S.
Response
Returns [H8Series!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterH8Series
|
Example
Query
query h8_series(
$offset: Int,
$filters: FilterH8Series
) {
h8_series(
offset: $offset,
filters: $filters
) {
balance_sheet_category
balance_sheet_item
bank_group
currency
frequency
h8_units
long_description
seasonal_adjustment
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"offset": 123, "filters": FilterH8Series}
Response
{
"data": {
"h8_series": [
{
"balance_sheet_category": "abc123",
"balance_sheet_item": "xyz789",
"bank_group": "xyz789",
"currency": "abc123",
"frequency": "xyz789",
"h8_units": "xyz789",
"long_description": "abc123",
"seasonal_adjustment": "abc123",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "xyz789",
"unit_multiplier": 987.65
}
]
}
}
h8_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterH8Series
|
Example
Query
query h8_series_count($filters: FilterH8Series) {
h8_series_count(filters: $filters)
}
Variables
{"filters": FilterH8Series}
Response
{"data": {"h8_series_count": 987}}
observation
Description
This endpoint returns the data values for a specfic series_name. The series_name can be attained using *_series endpoints.
Response
Returns [Observation!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterObservation
|
Example
Query
query observation(
$offset: Int,
$filters: FilterObservation
) {
observation(
offset: $offset,
filters: $filters
) {
series_name
status
time_period
value
}
}
Variables
{"offset": 987, "filters": FilterObservation}
Response
{
"data": {
"observation": [
{
"series_name": "abc123",
"status": "xyz789",
"time_period": NaiveDate,
"value": 123.45
}
]
}
}
observation_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterObservation
|
Example
Query
query observation_count($filters: FilterObservation) {
observation_count(filters: $filters)
}
Variables
{"filters": FilterObservation}
Response
{"data": {"observation_count": 123}}
prates_series
Description
Policy Rates
Response
Returns [PRATESSeries!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterPRATESSeries
|
Example
Query
query prates_series(
$offset: Int,
$filters: FilterPRATESSeries
) {
prates_series(
offset: $offset,
filters: $filters
) {
currency
frequency
interest_rates_paid_by_frs
long_description
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"offset": 987, "filters": FilterPRATESSeries}
Response
{
"data": {
"prates_series": [
{
"currency": "abc123",
"frequency": "abc123",
"interest_rates_paid_by_frs": "xyz789",
"long_description": "xyz789",
"series_name": "abc123",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 987.65
}
]
}
}
prates_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterPRATESSeries
|
Example
Query
query prates_series_count($filters: FilterPRATESSeries) {
prates_series_count(filters: $filters)
}
Variables
{"filters": FilterPRATESSeries}
Response
{"data": {"prates_series_count": 123}}
press_release
Description
All press release metadata on the US Board of Federal Reserve
Response
Returns [PressRelease!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterPressRelease
|
Example
Query
query press_release(
$offset: Int,
$filters: FilterPressRelease
) {
press_release(
offset: $offset,
filters: $filters
) {
category
description
guid
link
pub_datetime
title
}
}
Variables
{"offset": 123, "filters": FilterPressRelease}
Response
{
"data": {
"press_release": [
{
"category": "xyz789",
"description": "abc123",
"guid": "xyz789",
"link": "xyz789",
"pub_datetime": "2007-12-03T10:15:30Z",
"title": "xyz789"
}
]
}
}
press_release_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterPressRelease
|
Example
Query
query press_release_count($filters: FilterPressRelease) {
press_release_count(filters: $filters)
}
Variables
{"filters": FilterPressRelease}
Response
{"data": {"press_release_count": 987}}
scoos_series
Description
Senior Credit Officer Opinion Survey on Dealer Financing Terms
Response
Returns [SCOOSSeries!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterSCOOSSeries
|
Example
Query
query scoos_series(
$offset: Int,
$filters: FilterSCOOSSeries
) {
scoos_series(
offset: $offset,
filters: $filters
) {
frequency
long_description
question_group
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"offset": 987, "filters": FilterSCOOSSeries}
Response
{
"data": {
"scoos_series": [
{
"frequency": "xyz789",
"long_description": "abc123",
"question_group": "xyz789",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 987.65
}
]
}
}
scoos_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterSCOOSSeries
|
Example
Query
query scoos_series_count($filters: FilterSCOOSSeries) {
scoos_series_count(filters: $filters)
}
Variables
{"filters": FilterSCOOSSeries}
Response
{"data": {"scoos_series_count": 987}}
sloos_series
Description
Senior Loan Officer Opinion Survey on Bank Lending Practices
Response
Returns [SLOOSSeries!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterSLOOSSeries
|
Example
Query
query sloos_series(
$offset: Int,
$filters: FilterSLOOSSeries
) {
sloos_series(
offset: $offset,
filters: $filters
) {
bank_size
currency
direction_of_change
frequency
importance
loan_group
loan_type
long_description
measure
panel
reasons_for_changes_to_loan_conditions
series_name
short_description
terms
unit
unit_multiplier
}
}
Variables
{"offset": 987, "filters": FilterSLOOSSeries}
Response
{
"data": {
"sloos_series": [
{
"bank_size": "xyz789",
"currency": "abc123",
"direction_of_change": "abc123",
"frequency": "xyz789",
"importance": "xyz789",
"loan_group": "xyz789",
"loan_type": "xyz789",
"long_description": "xyz789",
"measure": "xyz789",
"panel": "xyz789",
"reasons_for_changes_to_loan_conditions": "abc123",
"series_name": "abc123",
"short_description": "xyz789",
"terms": "abc123",
"unit": "xyz789",
"unit_multiplier": 123.45
}
]
}
}
sloos_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterSLOOSSeries
|
Example
Query
query sloos_series_count($filters: FilterSLOOSSeries) {
sloos_series_count(filters: $filters)
}
Variables
{"filters": FilterSLOOSSeries}
Response
{"data": {"sloos_series_count": 123}}
z1_series
Response
Returns [Z1Series!]!
Arguments
| Name | Description |
|---|---|
offset - Int
|
|
filters - FilterZ1Series
|
Example
Query
query z1_series(
$offset: Int,
$filters: FilterZ1Series
) {
z1_series(
offset: $offset,
filters: $filters
) {
currency
frequency
instrument_description
long_description
sector_description
series_name
series_prefix_code_list
series_type
short_description
unit
unit_multiplier
}
}
Variables
{"offset": 987, "filters": FilterZ1Series}
Response
{
"data": {
"z1_series": [
{
"currency": "abc123",
"frequency": "xyz789",
"instrument_description": "xyz789",
"long_description": "abc123",
"sector_description": "xyz789",
"series_name": "xyz789",
"series_prefix_code_list": "xyz789",
"series_type": "xyz789",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 987.65
}
]
}
}
z1_series_count
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
filters - FilterZ1Series
|
Example
Query
query z1_series_count($filters: FilterZ1Series) {
z1_series_count(filters: $filters)
}
Variables
{"filters": FilterZ1Series}
Response
{"data": {"z1_series_count": 123}}
Subscriptions
chgdel_series
Description
Charge-Off and Delinquency Rates on Loans and Leases at Commercial Banks
Response
Returns an CHGDELSeries!
Arguments
| Name | Description |
|---|---|
filters - FilterCHGDELSeries
|
Example
Query
subscription chgdel_series($filters: FilterCHGDELSeries) {
chgdel_series(filters: $filters) {
component
currency
frequency
loan_type
long_description
rate_type
seasonal_adjustment
series_name
short_description
size_group
unit
unit_multiplier
}
}
Variables
{"filters": FilterCHGDELSeries}
Response
{
"data": {
"chgdel_series": {
"component": "xyz789",
"currency": "abc123",
"frequency": "abc123",
"loan_type": "abc123",
"long_description": "xyz789",
"rate_type": "xyz789",
"seasonal_adjustment": "abc123",
"series_name": "xyz789",
"short_description": "xyz789",
"size_group": "xyz789",
"unit": "abc123",
"unit_multiplier": 123.45
}
}
}
cp_series
Description
Commercial Paper Rates and Outstanding
Response
Returns a CPSeries!
Arguments
| Name | Description |
|---|---|
filters - FilterCPSeries
|
Example
Query
subscription cp_series($filters: FilterCPSeries) {
cp_series(filters: $filters) {
category
currency
frequency
long_description
maturity_range
maturity_term
rate_type
seasonal_adjustment
series_name
short_description
unit
unit_multiplier
volume_types
}
}
Variables
{"filters": FilterCPSeries}
Response
{
"data": {
"cp_series": {
"category": "xyz789",
"currency": "xyz789",
"frequency": "abc123",
"long_description": "xyz789",
"maturity_range": "abc123",
"maturity_term": "xyz789",
"rate_type": "xyz789",
"seasonal_adjustment": "abc123",
"series_name": "abc123",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 987.65,
"volume_types": "abc123"
}
}
}
e2_series
Description
Survey of Terms of Business Lending
Response
Returns an E2Series!
Arguments
| Name | Description |
|---|---|
filters - FilterE2Series
|
Example
Query
subscription e2_series($filters: FilterE2Series) {
e2_series(filters: $filters) {
base_rate_of_loan
commitment_status
currency
frequency
loan_characteristic
long_description
maturity_or_repricing_interval
panel
risk_rating
series_name
short_description
size_of_loan
summary_statistics
terms_set_before_survey_week
time_pricing_terms_were_set
unit
unit_multiplier
}
}
Variables
{"filters": FilterE2Series}
Response
{
"data": {
"e2_series": {
"base_rate_of_loan": "abc123",
"commitment_status": "abc123",
"currency": "xyz789",
"frequency": "xyz789",
"loan_characteristic": "abc123",
"long_description": "xyz789",
"maturity_or_repricing_interval": "abc123",
"panel": "xyz789",
"risk_rating": "abc123",
"series_name": "xyz789",
"short_description": "abc123",
"size_of_loan": "xyz789",
"summary_statistics": "abc123",
"terms_set_before_survey_week": "abc123",
"time_pricing_terms_were_set": "xyz789",
"unit": "abc123",
"unit_multiplier": 987.65
}
}
}
fomc_release
Description
Federal Open Market Committee (FOMC) Release and Target Rates. Use this endpoint for real-time interest rate announcements from the federal reserve.
Response
Returns an FOMCRelease!
Arguments
| Name | Description |
|---|---|
filters - FilterFOMCRelease
|
Example
Query
subscription fomc_release($filters: FilterFOMCRelease) {
fomc_release(filters: $filters) {
article
federal_funds_rate_target_range_high_end
federal_funds_rate_target_range_low_end
implementation_notes
interest_rate_paid_on_reserve_balances
press_release_guid
primary_credit_rate
pub_datetime
}
}
Variables
{"filters": FilterFOMCRelease}
Response
{
"data": {
"fomc_release": {
"article": "abc123",
"federal_funds_rate_target_range_high_end": 987.65,
"federal_funds_rate_target_range_low_end": 987.65,
"implementation_notes": "xyz789",
"interest_rate_paid_on_reserve_balances": 123.45,
"press_release_guid": "abc123",
"primary_credit_rate": 123.45,
"pub_datetime": "2007-12-03T10:15:30Z"
}
}
}
for_series
Description
Household Debt Service and Financial Obligations Ratios
Response
Returns an FORSeries!
Arguments
| Name | Description |
|---|---|
filters - FilterFORSeries
|
Example
Query
subscription for_series($filters: FilterFORSeries) {
for_series(filters: $filters) {
currency
debt
frequency
long_description
measure
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"filters": FilterFORSeries}
Response
{
"data": {
"for_series": {
"currency": "abc123",
"debt": "abc123",
"frequency": "xyz789",
"long_description": "xyz789",
"measure": "abc123",
"series_name": "xyz789",
"short_description": "abc123",
"unit": "xyz789",
"unit_multiplier": 123.45
}
}
}
g17_series
Description
Industrial Production and Capacity Utilization
Response
Returns a G17Series!
Arguments
| Name | Description |
|---|---|
filters - FilterG17Series
|
Example
Query
subscription g17_series($filters: FilterG17Series) {
g17_series(filters: $filters) {
currency
frequency
long_description
seasonal_adjustment
series_code
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"filters": FilterG17Series}
Response
{
"data": {
"g17_series": {
"currency": "xyz789",
"frequency": "abc123",
"long_description": "abc123",
"seasonal_adjustment": "xyz789",
"series_code": "abc123",
"series_name": "abc123",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 123.45
}
}
}
g19_series
Description
Consumer credit
Response
Returns a G19Series!
Arguments
| Name | Description |
|---|---|
filters - FilterG19Series
|
Example
Query
subscription g19_series($filters: FilterG19Series) {
g19_series(filters: $filters) {
credit_type
currency
data_representation
frequency
holder
issuer
long_description
seasonal_adjustment
series_name
short_description
terms_of_credit
unit
unit_multiplier
}
}
Variables
{"filters": FilterG19Series}
Response
{
"data": {
"g19_series": {
"credit_type": "xyz789",
"currency": "abc123",
"data_representation": "abc123",
"frequency": "abc123",
"holder": "xyz789",
"issuer": "abc123",
"long_description": "abc123",
"seasonal_adjustment": "xyz789",
"series_name": "abc123",
"short_description": "abc123",
"terms_of_credit": "xyz789",
"unit": "xyz789",
"unit_multiplier": 987.65
}
}
}
g20_series
Description
Finance Companies
Response
Returns a G20Series!
Arguments
| Name | Description |
|---|---|
filters - FilterG20Series
|
Example
Query
subscription g20_series($filters: FilterG20Series) {
g20_series(filters: $filters) {
asset_type
currency
data_representation
frequency
loan_terms
loan_type
long_description
seasonal_adjustment
series
series_category
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"filters": FilterG20Series}
Response
{
"data": {
"g20_series": {
"asset_type": "xyz789",
"currency": "abc123",
"data_representation": "xyz789",
"frequency": "xyz789",
"loan_terms": "xyz789",
"loan_type": "xyz789",
"long_description": "xyz789",
"seasonal_adjustment": "xyz789",
"series": "xyz789",
"series_category": "xyz789",
"series_name": "xyz789",
"short_description": "abc123",
"unit": "abc123",
"unit_multiplier": 987.65
}
}
}
g5_h10_series
Description
Foreign Exchange Rates
Response
Returns a G5H10Series!
Arguments
| Name | Description |
|---|---|
filters - FilterG5H10Series
|
Example
Query
subscription g5_h10_series($filters: FilterG5H10Series) {
g5_h10_series(filters: $filters) {
currency
currency_or_index_type
frequency
long_description
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"filters": FilterG5H10Series}
Response
{
"data": {
"g5_h10_series": {
"currency": "abc123",
"currency_or_index_type": "xyz789",
"frequency": "abc123",
"long_description": "abc123",
"series_name": "xyz789",
"short_description": "abc123",
"unit": "abc123",
"unit_multiplier": 987.65
}
}
}
h15_series
Description
Selected Interest Rates
Response
Returns a H15Series!
Arguments
| Name | Description |
|---|---|
filters - FilterH15Series
|
Example
Query
subscription h15_series($filters: FilterH15Series) {
h15_series(filters: $filters) {
currency
frequency
instrument
long_description
maturity
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"filters": FilterH15Series}
Response
{
"data": {
"h15_series": {
"currency": "xyz789",
"frequency": "xyz789",
"instrument": "abc123",
"long_description": "xyz789",
"maturity": "xyz789",
"series_name": "abc123",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 987.65
}
}
}
h3_series
Description
Aggregate Reserves of Depository Institutions and the Monetary Base
Response
Returns a H3Series!
Arguments
| Name | Description |
|---|---|
filters - FilterH3Series
|
Example
Query
subscription h3_series($filters: FilterH3Series) {
h3_series(filters: $filters) {
currency
frequency
long_description
reserves
reserves_detail
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"filters": FilterH3Series}
Response
{
"data": {
"h3_series": {
"currency": "xyz789",
"frequency": "abc123",
"long_description": "xyz789",
"reserves": "abc123",
"reserves_detail": "abc123",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 987.65
}
}
}
h41_series
Description
Factors Affecting Reserve Balances
Response
Returns a H41Series!
Arguments
| Name | Description |
|---|---|
filters - FilterH41Series
|
Example
Query
subscription h41_series($filters: FilterH41Series) {
h41_series(filters: $filters) {
currency
frequency
long_description
series_name
series_type
short_description
unit
unit_multiplier
}
}
Variables
{"filters": FilterH41Series}
Response
{
"data": {
"h41_series": {
"currency": "abc123",
"frequency": "xyz789",
"long_description": "abc123",
"series_name": "abc123",
"series_type": "xyz789",
"short_description": "abc123",
"unit": "abc123",
"unit_multiplier": 123.45
}
}
}
h6_series
Description
Money Stock Measures
Response
Returns a H6Series!
Arguments
| Name | Description |
|---|---|
filters - FilterH6Series
|
Example
Query
subscription h6_series($filters: FilterH6Series) {
h6_series(filters: $filters) {
currency
frequency
long_description
seasonal_adjustment
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"filters": FilterH6Series}
Response
{
"data": {
"h6_series": {
"currency": "abc123",
"frequency": "xyz789",
"long_description": "xyz789",
"seasonal_adjustment": "xyz789",
"series_name": "xyz789",
"short_description": "abc123",
"unit": "xyz789",
"unit_multiplier": 987.65
}
}
}
h8_series
Description
Assets and Liabilities of Commercial Banks in the U.S.
Response
Returns a H8Series!
Arguments
| Name | Description |
|---|---|
filters - FilterH8Series
|
Example
Query
subscription h8_series($filters: FilterH8Series) {
h8_series(filters: $filters) {
balance_sheet_category
balance_sheet_item
bank_group
currency
frequency
h8_units
long_description
seasonal_adjustment
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"filters": FilterH8Series}
Response
{
"data": {
"h8_series": {
"balance_sheet_category": "abc123",
"balance_sheet_item": "xyz789",
"bank_group": "xyz789",
"currency": "xyz789",
"frequency": "abc123",
"h8_units": "abc123",
"long_description": "xyz789",
"seasonal_adjustment": "abc123",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 123.45
}
}
}
observation
Description
This endpoint returns the real-time data values for a specfic series_name. The series_name can be attained using *_series endpoints in queries.
Response
Returns an Observation!
Arguments
| Name | Description |
|---|---|
filters - FilterObservation
|
Example
Query
subscription observation($filters: FilterObservation) {
observation(filters: $filters) {
series_name
status
time_period
value
}
}
Variables
{"filters": FilterObservation}
Response
{
"data": {
"observation": {
"series_name": "abc123",
"status": "abc123",
"time_period": NaiveDate,
"value": 987.65
}
}
}
prates_series
Description
Policy Rates
Response
Returns an PRATESSeries!
Arguments
| Name | Description |
|---|---|
filters - FilterPRATESSeries
|
Example
Query
subscription prates_series($filters: FilterPRATESSeries) {
prates_series(filters: $filters) {
currency
frequency
interest_rates_paid_by_frs
long_description
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"filters": FilterPRATESSeries}
Response
{
"data": {
"prates_series": {
"currency": "xyz789",
"frequency": "abc123",
"interest_rates_paid_by_frs": "xyz789",
"long_description": "abc123",
"series_name": "xyz789",
"short_description": "abc123",
"unit": "xyz789",
"unit_multiplier": 987.65
}
}
}
press_release
Description
All press release metadata on the US Board of Federal Reserve
Response
Returns a PressRelease!
Arguments
| Name | Description |
|---|---|
filters - FilterPressRelease
|
Example
Query
subscription press_release($filters: FilterPressRelease) {
press_release(filters: $filters) {
category
description
guid
link
pub_datetime
title
}
}
Variables
{"filters": FilterPressRelease}
Response
{
"data": {
"press_release": {
"category": "abc123",
"description": "xyz789",
"guid": "xyz789",
"link": "xyz789",
"pub_datetime": "2007-12-03T10:15:30Z",
"title": "xyz789"
}
}
}
scoos_series
Description
Senior Credit Officer Opinion Survey on Dealer Financing Terms
Response
Returns an SCOOSSeries!
Arguments
| Name | Description |
|---|---|
filters - FilterSCOOSSeries
|
Example
Query
subscription scoos_series($filters: FilterSCOOSSeries) {
scoos_series(filters: $filters) {
frequency
long_description
question_group
series_name
short_description
unit
unit_multiplier
}
}
Variables
{"filters": FilterSCOOSSeries}
Response
{
"data": {
"scoos_series": {
"frequency": "abc123",
"long_description": "abc123",
"question_group": "xyz789",
"series_name": "abc123",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 123.45
}
}
}
sloos_series
Description
Senior Loan Officer Opinion Survey on Bank Lending Practices
Response
Returns an SLOOSSeries!
Arguments
| Name | Description |
|---|---|
filters - FilterSLOOSSeries
|
Example
Query
subscription sloos_series($filters: FilterSLOOSSeries) {
sloos_series(filters: $filters) {
bank_size
currency
direction_of_change
frequency
importance
loan_group
loan_type
long_description
measure
panel
reasons_for_changes_to_loan_conditions
series_name
short_description
terms
unit
unit_multiplier
}
}
Variables
{"filters": FilterSLOOSSeries}
Response
{
"data": {
"sloos_series": {
"bank_size": "abc123",
"currency": "xyz789",
"direction_of_change": "xyz789",
"frequency": "abc123",
"importance": "abc123",
"loan_group": "abc123",
"loan_type": "xyz789",
"long_description": "abc123",
"measure": "abc123",
"panel": "xyz789",
"reasons_for_changes_to_loan_conditions": "abc123",
"series_name": "xyz789",
"short_description": "abc123",
"terms": "abc123",
"unit": "abc123",
"unit_multiplier": 123.45
}
}
}
z1_series
Description
Financial Accounts of the United States
Response
Returns a Z1Series!
Arguments
| Name | Description |
|---|---|
filters - FilterZ1Series
|
Example
Query
subscription z1_series($filters: FilterZ1Series) {
z1_series(filters: $filters) {
currency
frequency
instrument_description
long_description
sector_description
series_name
series_prefix_code_list
series_type
short_description
unit
unit_multiplier
}
}
Variables
{"filters": FilterZ1Series}
Response
{
"data": {
"z1_series": {
"currency": "abc123",
"frequency": "abc123",
"instrument_description": "xyz789",
"long_description": "xyz789",
"sector_description": "abc123",
"series_name": "abc123",
"series_prefix_code_list": "abc123",
"series_type": "xyz789",
"short_description": "abc123",
"unit": "abc123",
"unit_multiplier": 987.65
}
}
}
Types
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
CHGDELSeries
Example
{
"component": "abc123",
"currency": "abc123",
"frequency": "xyz789",
"loan_type": "xyz789",
"long_description": "abc123",
"rate_type": "abc123",
"seasonal_adjustment": "xyz789",
"series_name": "xyz789",
"short_description": "xyz789",
"size_group": "xyz789",
"unit": "xyz789",
"unit_multiplier": 987.65
}
CPSeries
Fields
| Field Name | Description |
|---|---|
category - String
|
|
currency - String
|
|
frequency - String
|
|
long_description - String
|
|
maturity_range - String
|
|
maturity_term - String
|
|
rate_type - String
|
|
seasonal_adjustment - String
|
|
series_name - String
|
|
short_description - String
|
|
unit - String
|
|
unit_multiplier - Float
|
|
volume_types - String
|
Example
{
"category": "xyz789",
"currency": "abc123",
"frequency": "abc123",
"long_description": "abc123",
"maturity_range": "xyz789",
"maturity_term": "xyz789",
"rate_type": "xyz789",
"seasonal_adjustment": "xyz789",
"series_name": "abc123",
"short_description": "xyz789",
"unit": "xyz789",
"unit_multiplier": 987.65,
"volume_types": "abc123"
}
DateTime
Description
Implement the DateTime
The input/output is a string in RFC3339 format.
Example
"2007-12-03T10:15:30Z"
DateTimeHighEnd
DateTimeLowEnd
DateTimeRange
Fields
| Input Field | Description |
|---|---|
lowEnd - DateTimeLowEnd
|
|
highEnd - DateTimeHighEnd
|
Example
{
"lowEnd": DateTimeLowEnd,
"highEnd": DateTimeHighEnd
}
E2Series
Fields
| Field Name | Description |
|---|---|
base_rate_of_loan - String
|
|
commitment_status - String
|
|
currency - String
|
|
frequency - String
|
|
loan_characteristic - String
|
|
long_description - String
|
|
maturity_or_repricing_interval - String
|
|
panel - String
|
|
risk_rating - String
|
|
series_name - String
|
|
short_description - String
|
|
size_of_loan - String
|
|
summary_statistics - String
|
|
terms_set_before_survey_week - String
|
|
time_pricing_terms_were_set - String
|
|
unit - String
|
|
unit_multiplier - Float
|
Example
{
"base_rate_of_loan": "abc123",
"commitment_status": "abc123",
"currency": "abc123",
"frequency": "abc123",
"loan_characteristic": "xyz789",
"long_description": "xyz789",
"maturity_or_repricing_interval": "abc123",
"panel": "xyz789",
"risk_rating": "abc123",
"series_name": "abc123",
"short_description": "xyz789",
"size_of_loan": "abc123",
"summary_statistics": "xyz789",
"terms_set_before_survey_week": "abc123",
"time_pricing_terms_were_set": "abc123",
"unit": "abc123",
"unit_multiplier": 987.65
}
F64HighEnd
F64LowEnd
F64Range
Fields
| Input Field | Description |
|---|---|
lowEnd - F64LowEnd
|
|
highEnd - F64HighEnd
|
Example
{
"lowEnd": F64LowEnd,
"highEnd": F64HighEnd
}
FOMCRelease
Fields
| Field Name | Description |
|---|---|
article - String
|
|
federal_funds_rate_target_range_high_end - Float
|
|
federal_funds_rate_target_range_low_end - Float
|
|
implementation_notes - String
|
|
interest_rate_paid_on_reserve_balances - Float
|
|
press_release_guid - String
|
|
primary_credit_rate - Float
|
|
pub_datetime - DateTime
|
Example
{
"article": "xyz789",
"federal_funds_rate_target_range_high_end": 987.65,
"federal_funds_rate_target_range_low_end": 123.45,
"implementation_notes": "xyz789",
"interest_rate_paid_on_reserve_balances": 987.65,
"press_release_guid": "abc123",
"primary_credit_rate": 987.65,
"pub_datetime": "2007-12-03T10:15:30Z"
}
FORSeries
Example
{
"currency": "abc123",
"debt": "xyz789",
"frequency": "xyz789",
"long_description": "xyz789",
"measure": "abc123",
"series_name": "abc123",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 987.65
}
FilterCHGDELSeries
Example
{
"component": "abc123",
"currency": "abc123",
"frequency": "abc123",
"loan_type": "xyz789",
"long_description": "xyz789",
"rate_type": "xyz789",
"seasonal_adjustment": "abc123",
"series_name": "abc123",
"short_description": "abc123",
"size_group": "xyz789",
"unit": "xyz789",
"unit_multiplier": FilterableF64
}
FilterCPSeries
Fields
| Input Field | Description |
|---|---|
category - String
|
|
currency - String
|
|
frequency - String
|
|
long_description - String
|
|
maturity_range - String
|
|
maturity_term - String
|
|
rate_type - String
|
|
seasonal_adjustment - String
|
|
series_name - String
|
|
short_description - String
|
|
unit - String
|
|
unit_multiplier - FilterableF64
|
|
volume_types - String
|
Example
{
"category": "xyz789",
"currency": "abc123",
"frequency": "abc123",
"long_description": "xyz789",
"maturity_range": "abc123",
"maturity_term": "abc123",
"rate_type": "xyz789",
"seasonal_adjustment": "abc123",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": FilterableF64,
"volume_types": "abc123"
}
FilterE2Series
Fields
| Input Field | Description |
|---|---|
base_rate_of_loan - String
|
|
commitment_status - String
|
|
currency - String
|
|
frequency - String
|
|
loan_characteristic - String
|
|
long_description - String
|
|
maturity_or_repricing_interval - String
|
|
panel - String
|
|
risk_rating - String
|
|
series_name - String
|
|
short_description - String
|
|
size_of_loan - String
|
|
summary_statistics - String
|
|
terms_set_before_survey_week - String
|
|
time_pricing_terms_were_set - String
|
|
unit - String
|
|
unit_multiplier - FilterableF64
|
Example
{
"base_rate_of_loan": "abc123",
"commitment_status": "xyz789",
"currency": "abc123",
"frequency": "xyz789",
"loan_characteristic": "xyz789",
"long_description": "xyz789",
"maturity_or_repricing_interval": "xyz789",
"panel": "xyz789",
"risk_rating": "abc123",
"series_name": "abc123",
"short_description": "abc123",
"size_of_loan": "xyz789",
"summary_statistics": "abc123",
"terms_set_before_survey_week": "xyz789",
"time_pricing_terms_were_set": "xyz789",
"unit": "xyz789",
"unit_multiplier": FilterableF64
}
FilterFOMCRelease
Fields
| Input Field | Description |
|---|---|
article - String
|
|
federal_funds_rate_target_range_high_end - FilterableF64
|
|
federal_funds_rate_target_range_low_end - FilterableF64
|
|
implementation_notes - String
|
|
interest_rate_paid_on_reserve_balances - FilterableF64
|
|
press_release_guid - String
|
|
primary_credit_rate - FilterableF64
|
|
pub_datetime - FilterableDateTime
|
Example
{
"article": "abc123",
"federal_funds_rate_target_range_high_end": FilterableF64,
"federal_funds_rate_target_range_low_end": FilterableF64,
"implementation_notes": "abc123",
"interest_rate_paid_on_reserve_balances": FilterableF64,
"press_release_guid": "xyz789",
"primary_credit_rate": FilterableF64,
"pub_datetime": FilterableDateTime
}
FilterFORSeries
Example
{
"currency": "abc123",
"debt": "xyz789",
"frequency": "abc123",
"long_description": "xyz789",
"measure": "xyz789",
"series_name": "abc123",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": FilterableF64
}
FilterG17Series
Example
{
"currency": "abc123",
"frequency": "abc123",
"long_description": "abc123",
"seasonal_adjustment": "abc123",
"series_code": "xyz789",
"series_name": "xyz789",
"short_description": "abc123",
"unit": "abc123",
"unit_multiplier": FilterableF64
}
FilterG19Series
Fields
| Input Field | Description |
|---|---|
credit_type - String
|
|
currency - String
|
|
data_representation - String
|
|
frequency - String
|
|
holder - String
|
|
issuer - String
|
|
long_description - String
|
|
seasonal_adjustment - String
|
|
series_name - String
|
|
short_description - String
|
|
terms_of_credit - String
|
|
unit - String
|
|
unit_multiplier - FilterableF64
|
Example
{
"credit_type": "xyz789",
"currency": "xyz789",
"data_representation": "xyz789",
"frequency": "xyz789",
"holder": "xyz789",
"issuer": "xyz789",
"long_description": "abc123",
"seasonal_adjustment": "xyz789",
"series_name": "xyz789",
"short_description": "abc123",
"terms_of_credit": "xyz789",
"unit": "abc123",
"unit_multiplier": FilterableF64
}
FilterG20Series
Fields
| Input Field | Description |
|---|---|
asset_type - String
|
|
currency - String
|
|
data_representation - String
|
|
frequency - String
|
|
loan_terms - String
|
|
loan_type - String
|
|
long_description - String
|
|
seasonal_adjustment - String
|
|
series - String
|
|
series_category - String
|
|
series_name - String
|
|
short_description - String
|
|
unit - String
|
|
unit_multiplier - FilterableF64
|
Example
{
"asset_type": "xyz789",
"currency": "abc123",
"data_representation": "xyz789",
"frequency": "abc123",
"loan_terms": "abc123",
"loan_type": "xyz789",
"long_description": "abc123",
"seasonal_adjustment": "abc123",
"series": "abc123",
"series_category": "abc123",
"series_name": "abc123",
"short_description": "abc123",
"unit": "abc123",
"unit_multiplier": FilterableF64
}
FilterG5H10Series
Example
{
"currency": "xyz789",
"currency_or_index_type": "abc123",
"frequency": "xyz789",
"long_description": "xyz789",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "xyz789",
"unit_multiplier": FilterableF64
}
FilterH15Series
Example
{
"currency": "xyz789",
"frequency": "abc123",
"instrument": "xyz789",
"long_description": "abc123",
"maturity": "xyz789",
"series_name": "abc123",
"short_description": "abc123",
"unit": "abc123",
"unit_multiplier": FilterableF64
}
FilterH3Series
Example
{
"currency": "xyz789",
"frequency": "abc123",
"long_description": "abc123",
"reserves": "abc123",
"reserves_detail": "xyz789",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": FilterableF64
}
FilterH41Series
Example
{
"currency": "abc123",
"frequency": "abc123",
"long_description": "abc123",
"series_name": "xyz789",
"series_type": "xyz789",
"short_description": "xyz789",
"unit": "xyz789",
"unit_multiplier": FilterableF64
}
FilterH6Series
Example
{
"currency": "abc123",
"frequency": "xyz789",
"long_description": "abc123",
"seasonal_adjustment": "abc123",
"series_name": "abc123",
"short_description": "abc123",
"unit": "xyz789",
"unit_multiplier": FilterableF64
}
FilterH8Series
Fields
| Input Field | Description |
|---|---|
balance_sheet_category - String
|
|
balance_sheet_item - String
|
|
bank_group - String
|
|
currency - String
|
|
frequency - String
|
|
h8_units - String
|
|
long_description - String
|
|
seasonal_adjustment - String
|
|
series_name - String
|
|
short_description - String
|
|
unit - String
|
|
unit_multiplier - FilterableF64
|
Example
{
"balance_sheet_category": "xyz789",
"balance_sheet_item": "abc123",
"bank_group": "abc123",
"currency": "abc123",
"frequency": "abc123",
"h8_units": "xyz789",
"long_description": "abc123",
"seasonal_adjustment": "xyz789",
"series_name": "abc123",
"short_description": "abc123",
"unit": "xyz789",
"unit_multiplier": FilterableF64
}
FilterObservation
Fields
| Input Field | Description |
|---|---|
series_name - String
|
|
status - String
|
|
time_period - FilterableNaiveDate
|
|
value - FilterableF64
|
Example
{
"series_name": "abc123",
"status": "xyz789",
"time_period": FilterableNaiveDate,
"value": FilterableF64
}
FilterPRATESSeries
Example
{
"currency": "abc123",
"frequency": "xyz789",
"interest_rates_paid_by_frs": "xyz789",
"long_description": "xyz789",
"series_name": "xyz789",
"short_description": "abc123",
"unit": "abc123",
"unit_multiplier": FilterableF64
}
FilterPressRelease
FilterSCOOSSeries
Example
{
"frequency": "abc123",
"long_description": "abc123",
"question_group": "abc123",
"series_name": "abc123",
"short_description": "xyz789",
"unit": "xyz789",
"unit_multiplier": FilterableF64
}
FilterSLOOSSeries
Fields
| Input Field | Description |
|---|---|
bank_size - String
|
|
currency - String
|
|
direction_of_change - String
|
|
frequency - String
|
|
importance - String
|
|
loan_group - String
|
|
loan_type - String
|
|
long_description - String
|
|
measure - String
|
|
panel - String
|
|
reasons_for_changes_to_loan_conditions - String
|
|
series_name - String
|
|
short_description - String
|
|
terms - String
|
|
unit - String
|
|
unit_multiplier - FilterableF64
|
Example
{
"bank_size": "xyz789",
"currency": "abc123",
"direction_of_change": "xyz789",
"frequency": "abc123",
"importance": "xyz789",
"loan_group": "xyz789",
"loan_type": "abc123",
"long_description": "abc123",
"measure": "xyz789",
"panel": "abc123",
"reasons_for_changes_to_loan_conditions": "xyz789",
"series_name": "xyz789",
"short_description": "abc123",
"terms": "xyz789",
"unit": "abc123",
"unit_multiplier": FilterableF64
}
FilterZ1Series
Fields
| Input Field | Description |
|---|---|
currency - String
|
|
frequency - String
|
|
instrument_description - String
|
|
long_description - String
|
|
sector_description - String
|
|
series_name - String
|
|
series_prefix_code_list - String
|
|
series_type - String
|
|
short_description - String
|
|
unit - String
|
|
unit_multiplier - FilterableF64
|
Example
{
"currency": "xyz789",
"frequency": "abc123",
"instrument_description": "xyz789",
"long_description": "xyz789",
"sector_description": "xyz789",
"series_name": "xyz789",
"series_prefix_code_list": "abc123",
"series_type": "xyz789",
"short_description": "abc123",
"unit": "xyz789",
"unit_multiplier": FilterableF64
}
FilterableDateTime
Fields
| Input Field | Description |
|---|---|
equal - DateTime
|
|
range - DateTimeRange
|
Example
{
"equal": "2007-12-03T10:15:30Z",
"range": DateTimeRange
}
FilterableF64
FilterableNaiveDate
Fields
| Input Field | Description |
|---|---|
equal - NaiveDate
|
|
range - NaiveDateRange
|
Example
{
"equal": NaiveDate,
"range": NaiveDateRange
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
G17Series
Example
{
"currency": "xyz789",
"frequency": "xyz789",
"long_description": "xyz789",
"seasonal_adjustment": "abc123",
"series_code": "xyz789",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 987.65
}
G19Series
Fields
| Field Name | Description |
|---|---|
credit_type - String
|
|
currency - String
|
|
data_representation - String
|
|
frequency - String
|
|
holder - String
|
|
issuer - String
|
|
long_description - String
|
|
seasonal_adjustment - String
|
|
series_name - String
|
|
short_description - String
|
|
terms_of_credit - String
|
|
unit - String
|
|
unit_multiplier - Float
|
Example
{
"credit_type": "xyz789",
"currency": "xyz789",
"data_representation": "xyz789",
"frequency": "abc123",
"holder": "abc123",
"issuer": "xyz789",
"long_description": "abc123",
"seasonal_adjustment": "abc123",
"series_name": "abc123",
"short_description": "xyz789",
"terms_of_credit": "abc123",
"unit": "xyz789",
"unit_multiplier": 123.45
}
G20Series
Fields
| Field Name | Description |
|---|---|
asset_type - String
|
|
currency - String
|
|
data_representation - String
|
|
frequency - String
|
|
loan_terms - String
|
|
loan_type - String
|
|
long_description - String
|
|
seasonal_adjustment - String
|
|
series - String
|
|
series_category - String
|
|
series_name - String
|
|
short_description - String
|
|
unit - String
|
|
unit_multiplier - Float
|
Example
{
"asset_type": "abc123",
"currency": "xyz789",
"data_representation": "abc123",
"frequency": "abc123",
"loan_terms": "xyz789",
"loan_type": "xyz789",
"long_description": "abc123",
"seasonal_adjustment": "abc123",
"series": "xyz789",
"series_category": "abc123",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 123.45
}
G5H10Series
Example
{
"currency": "xyz789",
"currency_or_index_type": "xyz789",
"frequency": "xyz789",
"long_description": "abc123",
"series_name": "abc123",
"short_description": "abc123",
"unit": "abc123",
"unit_multiplier": 123.45
}
H15Series
Example
{
"currency": "xyz789",
"frequency": "xyz789",
"instrument": "abc123",
"long_description": "abc123",
"maturity": "abc123",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "xyz789",
"unit_multiplier": 123.45
}
H3Series
Example
{
"currency": "xyz789",
"frequency": "abc123",
"long_description": "abc123",
"reserves": "abc123",
"reserves_detail": "abc123",
"series_name": "abc123",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 123.45
}
H41Series
Example
{
"currency": "abc123",
"frequency": "abc123",
"long_description": "abc123",
"series_name": "xyz789",
"series_type": "abc123",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 987.65
}
H6Series
Example
{
"currency": "abc123",
"frequency": "abc123",
"long_description": "xyz789",
"seasonal_adjustment": "xyz789",
"series_name": "abc123",
"short_description": "abc123",
"unit": "abc123",
"unit_multiplier": 123.45
}
H8Series
Fields
| Field Name | Description |
|---|---|
balance_sheet_category - String
|
|
balance_sheet_item - String
|
|
bank_group - String
|
|
currency - String
|
|
frequency - String
|
|
h8_units - String
|
|
long_description - String
|
|
seasonal_adjustment - String
|
|
series_name - String
|
|
short_description - String
|
|
unit - String
|
|
unit_multiplier - Float
|
Example
{
"balance_sheet_category": "xyz789",
"balance_sheet_item": "xyz789",
"bank_group": "xyz789",
"currency": "abc123",
"frequency": "abc123",
"h8_units": "xyz789",
"long_description": "abc123",
"seasonal_adjustment": "xyz789",
"series_name": "xyz789",
"short_description": "abc123",
"unit": "abc123",
"unit_multiplier": 123.45
}
Int
Description
The Int scalar type represents non-fractional whole numeric values.
Example
987
NaiveDate
Description
ISO 8601 calendar date without timezone. Format: %Y-%m-%d
Examples
1994-11-132000-02-24
Example
NaiveDate
NaiveDateHighEnd
NaiveDateLowEnd
NaiveDateRange
Fields
| Input Field | Description |
|---|---|
lowEnd - NaiveDateLowEnd
|
|
highEnd - NaiveDateHighEnd
|
Example
{
"lowEnd": NaiveDateLowEnd,
"highEnd": NaiveDateHighEnd
}
Observation
Fields
| Field Name | Description |
|---|---|
series_name - String
|
|
status - String
|
|
time_period - NaiveDate!
|
|
value - Float
|
Example
{
"series_name": "xyz789",
"status": "xyz789",
"time_period": NaiveDate,
"value": 123.45
}
PRATESSeries
Example
{
"currency": "abc123",
"frequency": "abc123",
"interest_rates_paid_by_frs": "xyz789",
"long_description": "abc123",
"series_name": "xyz789",
"short_description": "xyz789",
"unit": "abc123",
"unit_multiplier": 123.45
}
PressRelease
SCOOSSeries
Example
{
"frequency": "xyz789",
"long_description": "xyz789",
"question_group": "abc123",
"series_name": "abc123",
"short_description": "xyz789",
"unit": "xyz789",
"unit_multiplier": 987.65
}
SLOOSSeries
Fields
| Field Name | Description |
|---|---|
bank_size - String
|
|
currency - String
|
|
direction_of_change - String
|
|
frequency - String
|
|
importance - String
|
|
loan_group - String
|
|
loan_type - String
|
|
long_description - String
|
|
measure - String
|
|
panel - String
|
|
reasons_for_changes_to_loan_conditions - String
|
|
series_name - String
|
|
short_description - String
|
|
terms - String
|
|
unit - String
|
|
unit_multiplier - Float
|
Example
{
"bank_size": "abc123",
"currency": "abc123",
"direction_of_change": "xyz789",
"frequency": "abc123",
"importance": "xyz789",
"loan_group": "abc123",
"loan_type": "xyz789",
"long_description": "abc123",
"measure": "abc123",
"panel": "xyz789",
"reasons_for_changes_to_loan_conditions": "abc123",
"series_name": "abc123",
"short_description": "xyz789",
"terms": "xyz789",
"unit": "abc123",
"unit_multiplier": 987.65
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
Z1Series
Example
{
"currency": "abc123",
"frequency": "xyz789",
"instrument_description": "xyz789",
"long_description": "xyz789",
"sector_description": "abc123",
"series_name": "xyz789",
"series_prefix_code_list": "abc123",
"series_type": "abc123",
"short_description": "abc123",
"unit": "abc123",
"unit_multiplier": 987.65
}