US Bureau of Economic Analysis GraphQL Documentation

This documentation includes the GraphQL query and subscription specification for access to the US Bureau of Economic Analysis (US BEA) data on our platform.

Contact

Beam API Support

support@beamapi.com

https://beamapi.freshdesk.com

Terms of Service

https://beamapi.com/terms

API Endpoints
# Production Server for Queries:
https://api.beamapi.com/data/fundamentals/us/us_bea/v1/
# Production Server for Subscriptions:
wss://api.beamapi.com/data/fundamentals/us/us_bea/v1/ws
Version

1

Queries

file

Response

Returns [Usbeafile!]!

Arguments
Name Description
offset - Int
filters - FilterUSBEAFile

Example

Query
query file(
  $offset: Int,
  $filters: FilterUSBEAFile
) {
  file(
    offset: $offset,
    filters: $filters
  ) {
    file_modified_at
    filename
  }
}
Variables
{"offset": 123, "filters": FilterUSBEAFile}
Response
{
  "data": {
    "file": [
      {
        "file_modified_at": "2007-12-03T10:15:30Z",
        "filename": "abc123"
      }
    ]
  }
}
Queries

file_count

Response

Returns an Int!

Arguments
Name Description
filters - FilterUSBEAFile

Example

Query
query file_count($filters: FilterUSBEAFile) {
  file_count(filters: $filters)
}
Variables
{"filters": FilterUSBEAFile}
Response
{"data": {"file_count": 123}}
Queries

series

Response

Returns [Usbeaseries!]!

Arguments
Name Description
offset - Int
filters - FilterUSBEASeries

Example

Query
query series(
  $offset: Int,
  $filters: FilterUSBEASeries
) {
  series(
    offset: $offset,
    filters: $filters
  ) {
    calculation_type
    default_scale
    metric_name
    series_code
    series_code_parents
    series_label
    table_id_and_line_number
  }
}
Variables
{"offset": 123, "filters": FilterUSBEASeries}
Response
{
  "data": {
    "series": [
      {
        "calculation_type": "xyz789",
        "default_scale": 987.65,
        "metric_name": "xyz789",
        "series_code": "abc123",
        "series_code_parents": "xyz789",
        "series_label": "xyz789",
        "table_id_and_line_number": "abc123"
      }
    ]
  }
}
Queries

series_count

Response

Returns an Int!

Arguments
Name Description
filters - FilterUSBEASeries

Example

Query
query series_count($filters: FilterUSBEASeries) {
  series_count(filters: $filters)
}
Variables
{"filters": FilterUSBEASeries}
Response
{"data": {"series_count": 987}}
Queries

series_data

Response

Returns [UsbeaseriesData!]!

Arguments
Name Description
offset - Int
filters - FilterUSBEASeriesData

Example

Query
query series_data(
  $offset: Int,
  $filters: FilterUSBEASeriesData
) {
  series_data(
    offset: $offset,
    filters: $filters
  ) {
    period
    series_code
    value
    year
  }
}
Variables
{"offset": 123, "filters": FilterUSBEASeriesData}
Response
{
  "data": {
    "series_data": [
      {
        "period": "xyz789",
        "series_code": "abc123",
        "value": 987.65,
        "year": 123
      }
    ]
  }
}
Queries

series_data_count

Response

Returns an Int!

Arguments
Name Description
filters - FilterUSBEASeriesData

Example

Query
query series_data_count($filters: FilterUSBEASeriesData) {
  series_data_count(filters: $filters)
}
Variables
{"filters": FilterUSBEASeriesData}
Response
{"data": {"series_data_count": 987}}

Subscriptions

file

Response

Returns an Usbeafile!

Arguments
Name Description
filters - FilterUSBEAFile

Example

Query
subscription file($filters: FilterUSBEAFile) {
  file(filters: $filters) {
    file_modified_at
    filename
  }
}
Variables
{"filters": FilterUSBEAFile}
Response
{
  "data": {
    "file": {
      "file_modified_at": "2007-12-03T10:15:30Z",
      "filename": "xyz789"
    }
  }
}
Subscriptions

series

Response

Returns an Usbeaseries!

Arguments
Name Description
filters - FilterUSBEASeries

Example

Query
subscription series($filters: FilterUSBEASeries) {
  series(filters: $filters) {
    calculation_type
    default_scale
    metric_name
    series_code
    series_code_parents
    series_label
    table_id_and_line_number
  }
}
Variables
{"filters": FilterUSBEASeries}
Response
{
  "data": {
    "series": {
      "calculation_type": "abc123",
      "default_scale": 123.45,
      "metric_name": "abc123",
      "series_code": "xyz789",
      "series_code_parents": "xyz789",
      "series_label": "xyz789",
      "table_id_and_line_number": "abc123"
    }
  }
}
Subscriptions

series_data

Response

Returns an UsbeaseriesData!

Arguments
Name Description
filters - FilterUSBEASeriesData

Example

Query
subscription series_data($filters: FilterUSBEASeriesData) {
  series_data(filters: $filters) {
    period
    series_code
    value
    year
  }
}
Variables
{"filters": FilterUSBEASeriesData}
Response
{
  "data": {
    "series_data": {
      "period": "xyz789",
      "series_code": "abc123",
      "value": 987.65,
      "year": 123
    }
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
true
Types

DateTime

Description

Implement the DateTime scalar

The input/output is a string in RFC3339 format.

Example
"2007-12-03T10:15:30Z"
Types

DateTimeHighEnd

Fields
Input Field Description
le - DateTime
lt - DateTime
Example
{
  "le": "2007-12-03T10:15:30Z",
  "lt": "2007-12-03T10:15:30Z"
}
Types

DateTimeLowEnd

Fields
Input Field Description
ge - DateTime
gt - DateTime
Example
{
  "ge": "2007-12-03T10:15:30Z",
  "gt": "2007-12-03T10:15:30Z"
}
Types

DateTimeRange

Fields
Input Field Description
lowEnd - DateTimeLowEnd
highEnd - DateTimeHighEnd
Example
{
  "lowEnd": DateTimeLowEnd,
  "highEnd": DateTimeHighEnd
}
Types

F64HighEnd

Fields
Input Field Description
le - Float
lt - Float
Example
{"le": 987.65, "lt": 123.45}
Types

F64LowEnd

Fields
Input Field Description
ge - Float
gt - Float
Example
{"ge": 123.45, "gt": 987.65}
Types

F64Range

Fields
Input Field Description
lowEnd - F64LowEnd
highEnd - F64HighEnd
Example
{
  "lowEnd": F64LowEnd,
  "highEnd": F64HighEnd
}
Types

FilterUSBEAFile

Fields
Input Field Description
file_modified_at - FilterableDateTime
filename - String
Example
{
  "file_modified_at": FilterableDateTime,
  "filename": "abc123"
}
Types

FilterUSBEASeries

Fields
Input Field Description
calculation_type - String
default_scale - FilterableF64
metric_name - String
series_code - String
series_code_parents - String
series_label - String
table_id_and_line_number - String
Example
{
  "calculation_type": "abc123",
  "default_scale": FilterableF64,
  "metric_name": "xyz789",
  "series_code": "abc123",
  "series_code_parents": "xyz789",
  "series_label": "xyz789",
  "table_id_and_line_number": "xyz789"
}
Types

FilterUSBEASeriesData

Fields
Input Field Description
period - String
series_code - String
value - FilterableF64
year - FilterableI32
Example
{
  "period": "abc123",
  "series_code": "abc123",
  "value": FilterableF64,
  "year": FilterableI32
}
Types

FilterableDateTime

Fields
Input Field Description
equal - DateTime
range - DateTimeRange
Example
{
  "equal": "2007-12-03T10:15:30Z",
  "range": DateTimeRange
}
Types

FilterableF64

Fields
Input Field Description
equal - Float
range - F64Range
Example
{"equal": 123.45, "range": F64Range}
Types

FilterableI32

Fields
Input Field Description
equal - Int
range - I32Range
Example
{"equal": 987, "range": I32Range}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

I32HighEnd

Fields
Input Field Description
le - Int
lt - Int
Example
{"le": 123, "lt": 123}
Types

I32LowEnd

Fields
Input Field Description
ge - Int
gt - Int
Example
{"ge": 987, "gt": 987}
Types

I32Range

Fields
Input Field Description
lowEnd - I32LowEnd
highEnd - I32HighEnd
Example
{
  "lowEnd": I32LowEnd,
  "highEnd": I32HighEnd
}
Types

Int

Description

The Int scalar type represents non-fractional whole numeric values.

Example
123
Types

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"
Types

Usbeafile

Fields
Field Name Description
file_modified_at - DateTime
filename - String
Example
{
  "file_modified_at": "2007-12-03T10:15:30Z",
  "filename": "abc123"
}
Types

Usbeaseries

Fields
Field Name Description
calculation_type - String
default_scale - Float
metric_name - String
series_code - String
series_code_parents - String
series_label - String
table_id_and_line_number - String
Example
{
  "calculation_type": "abc123",
  "default_scale": 987.65,
  "metric_name": "xyz789",
  "series_code": "xyz789",
  "series_code_parents": "abc123",
  "series_label": "abc123",
  "table_id_and_line_number": "xyz789"
}
Types

UsbeaseriesData

Fields
Field Name Description
period - String
series_code - String
value - Float
year - Int
Example
{
  "period": "abc123",
  "series_code": "abc123",
  "value": 123.45,
  "year": 123
}
Documentation by Anvil SpectaQL