SEC EDGAR Metadata GraphQL Documentation

This documentation includes the GraphQL query and subscription specification for access to the Securities and Exchange Commission (SEC EDGAR ) data on our platform. To send requests and start subscriptions, search for a community-supported GraphQL client in your programming language of choice.

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/sec/metadata/v1/
# Production Server for Subscriptions:
wss://api.beamapi.com/data/fundamentals/us/sec/metadata/v1/ws
Version

1

Queries

entity

Response

Returns [Entity!]!

Arguments
Name Description
offset - Int
filters - FilterEntity

Example

Query
query entity(
  $offset: Int,
  $filters: FilterEntity
) {
  entity(
    offset: $offset,
    filters: $filters
  ) {
    business_address_city
    business_address_state_or_country
    business_address_state_or_country_description
    business_address_street_1
    business_address_street_2
    business_address_zip_code
    category
    cik
    description
    ein
    entity_type
    exchanges
    fiscal_year_end
    flags
    insider_transaction_for_issuer_exists
    insider_transaction_for_owner_exists
    investor_website
    mailing_address_city
    mailing_address_state_or_country
    mailing_address_state_or_country_description
    mailing_address_street_1
    mailing_address_street_2
    mailing_address_zip_code
    name
    phone
    sic
    sic_description
    state_of_incorporation
    state_of_incorporation_description
    tickers
    website
  }
}
Variables
{"offset": 987, "filters": FilterEntity}
Response
{
  "data": {
    "entity": [
      {
        "business_address_city": "abc123",
        "business_address_state_or_country": "abc123",
        "business_address_state_or_country_description": "abc123",
        "business_address_street_1": "xyz789",
        "business_address_street_2": "abc123",
        "business_address_zip_code": "abc123",
        "category": "xyz789",
        "cik": 123,
        "description": "xyz789",
        "ein": "xyz789",
        "entity_type": "abc123",
        "exchanges": ["abc123"],
        "fiscal_year_end": "xyz789",
        "flags": "abc123",
        "insider_transaction_for_issuer_exists": false,
        "insider_transaction_for_owner_exists": true,
        "investor_website": "xyz789",
        "mailing_address_city": "xyz789",
        "mailing_address_state_or_country": "xyz789",
        "mailing_address_state_or_country_description": "xyz789",
        "mailing_address_street_1": "abc123",
        "mailing_address_street_2": "xyz789",
        "mailing_address_zip_code": "abc123",
        "name": "xyz789",
        "phone": "xyz789",
        "sic": "abc123",
        "sic_description": "abc123",
        "state_of_incorporation": "xyz789",
        "state_of_incorporation_description": "abc123",
        "tickers": ["xyz789"],
        "website": "xyz789"
      }
    ]
  }
}
Queries

entity_count

Response

Returns an Int!

Arguments
Name Description
filters - FilterEntity

Example

Query
query entity_count($filters: FilterEntity) {
  entity_count(filters: $filters)
}
Variables
{"filters": FilterEntity}
Response
{"data": {"entity_count": 123}}
Queries

filing

Response

Returns [Filing!]!

Arguments
Name Description
offset - Int
filters - FilterFiling

Example

Query
query filing(
  $offset: Int,
  $filters: FilterFiling
) {
  filing(
    offset: $offset,
    filters: $filters
  ) {
    acceptance_datetime
    accession_number
    entity_cik
    file_number
    filing_date
    film_number
    filing_index_url
    form_type
    is_from_feed
    primary_document_description
    primary_document_name
    report_date
  }
}
Variables
{"offset": 123, "filters": FilterFiling}
Response
{
  "data": {
    "filing": [
      {
        "acceptance_datetime": "2007-12-03T10:15:30Z",
        "accession_number": 123,
        "entity_cik": 987,
        "file_number": "xyz789",
        "filing_date": NaiveDate,
        "film_number": "abc123",
        "filing_index_url": "xyz789",
        "form_type": "xyz789",
        "is_from_feed": true,
        "primary_document_description": "xyz789",
        "primary_document_name": "xyz789",
        "report_date": NaiveDate
      }
    ]
  }
}
Queries

filing_count

Response

Returns an Int!

Arguments
Name Description
filters - FilterFiling

Example

Query
query filing_count($filters: FilterFiling) {
  filing_count(filters: $filters)
}
Variables
{"filters": FilterFiling}
Response
{"data": {"filing_count": 123}}
Queries

former_name

Response

Returns [FormerName!]!

Arguments
Name Description
offset - Int
filters - FilterFormerName

Example

Query
query former_name(
  $offset: Int,
  $filters: FilterFormerName
) {
  former_name(
    offset: $offset,
    filters: $filters
  ) {
    cik
    from_datetime
    name
    to_datetime
  }
}
Variables
{"offset": 123, "filters": FilterFormerName}
Response
{
  "data": {
    "former_name": [
      {
        "cik": 123,
        "from_datetime": "2007-12-03T10:15:30Z",
        "name": "xyz789",
        "to_datetime": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

former_name_count

Response

Returns an Int!

Arguments
Name Description
filters - FilterFormerName

Example

Query
query former_name_count($filters: FilterFormerName) {
  former_name_count(filters: $filters)
}
Variables
{"filters": FilterFormerName}
Response
{"data": {"former_name_count": 987}}
Queries

publicly_listed_security

Response

Returns [PubliclyListedSecurity!]!

Arguments
Name Description
offset - Int
filters - FilterPubliclyListedSecurity

Example

Query
query publicly_listed_security(
  $offset: Int,
  $filters: FilterPubliclyListedSecurity
) {
  publicly_listed_security(
    offset: $offset,
    filters: $filters
  ) {
    entity_cik
    exchange
    ticker
  }
}
Variables
{"offset": 987, "filters": FilterPubliclyListedSecurity}
Response
{
  "data": {
    "publicly_listed_security": [
      {
        "entity_cik": 987,
        "exchange": "xyz789",
        "ticker": "abc123"
      }
    ]
  }
}
Queries

publicly_listed_security_count

Response

Returns an Int!

Arguments
Name Description
filters - FilterPubliclyListedSecurity

Example

Query
query publicly_listed_security_count($filters: FilterPubliclyListedSecurity) {
  publicly_listed_security_count(filters: $filters)
}
Variables
{"filters": FilterPubliclyListedSecurity}
Response
{"data": {"publicly_listed_security_count": 123}}

Subscriptions

entity

Response

Returns an Entity!

Arguments
Name Description
filters - FilterEntity

Example

Query
subscription entity($filters: FilterEntity) {
  entity(filters: $filters) {
    business_address_city
    business_address_state_or_country
    business_address_state_or_country_description
    business_address_street_1
    business_address_street_2
    business_address_zip_code
    category
    cik
    description
    ein
    entity_type
    exchanges
    fiscal_year_end
    flags
    insider_transaction_for_issuer_exists
    insider_transaction_for_owner_exists
    investor_website
    mailing_address_city
    mailing_address_state_or_country
    mailing_address_state_or_country_description
    mailing_address_street_1
    mailing_address_street_2
    mailing_address_zip_code
    name
    phone
    sic
    sic_description
    state_of_incorporation
    state_of_incorporation_description
    tickers
    website
  }
}
Variables
{"filters": FilterEntity}
Response
{
  "data": {
    "entity": {
      "business_address_city": "xyz789",
      "business_address_state_or_country": "abc123",
      "business_address_state_or_country_description": "abc123",
      "business_address_street_1": "xyz789",
      "business_address_street_2": "xyz789",
      "business_address_zip_code": "xyz789",
      "category": "abc123",
      "cik": 987,
      "description": "abc123",
      "ein": "abc123",
      "entity_type": "abc123",
      "exchanges": ["xyz789"],
      "fiscal_year_end": "abc123",
      "flags": "abc123",
      "insider_transaction_for_issuer_exists": false,
      "insider_transaction_for_owner_exists": true,
      "investor_website": "xyz789",
      "mailing_address_city": "abc123",
      "mailing_address_state_or_country": "abc123",
      "mailing_address_state_or_country_description": "abc123",
      "mailing_address_street_1": "abc123",
      "mailing_address_street_2": "abc123",
      "mailing_address_zip_code": "abc123",
      "name": "xyz789",
      "phone": "abc123",
      "sic": "xyz789",
      "sic_description": "abc123",
      "state_of_incorporation": "xyz789",
      "state_of_incorporation_description": "xyz789",
      "tickers": ["abc123"],
      "website": "abc123"
    }
  }
}
Subscriptions

filing

Response

Returns a Filing!

Arguments
Name Description
filters - FilterFiling

Example

Query
subscription filing($filters: FilterFiling) {
  filing(filters: $filters) {
    acceptance_datetime
    accession_number
    entity_cik
    file_number
    filing_date
    film_number
    filing_index_url
    form_type
    is_from_feed
    primary_document_description
    primary_document_name
    report_date
  }
}
Variables
{"filters": FilterFiling}
Response
{
  "data": {
    "filing": {
      "acceptance_datetime": "2007-12-03T10:15:30Z",
      "accession_number": 123,
      "entity_cik": 987,
      "file_number": "xyz789",
      "filing_date": NaiveDate,
      "film_number": "abc123",
      "filing_index_url": "abc123",
      "form_type": "abc123",
      "is_from_feed": false,
      "primary_document_description": "abc123",
      "primary_document_name": "abc123",
      "report_date": NaiveDate
    }
  }
}
Subscriptions

former_name

Response

Returns a FormerName!

Arguments
Name Description
filters - FilterFormerName

Example

Query
subscription former_name($filters: FilterFormerName) {
  former_name(filters: $filters) {
    cik
    from_datetime
    name
    to_datetime
  }
}
Variables
{"filters": FilterFormerName}
Response
{
  "data": {
    "former_name": {
      "cik": 123,
      "from_datetime": "2007-12-03T10:15:30Z",
      "name": "abc123",
      "to_datetime": "2007-12-03T10:15:30Z"
    }
  }
}
Subscriptions

publicly_listed_security

Response

Returns a PubliclyListedSecurity!

Arguments
Name Description
filters - FilterPubliclyListedSecurity

Example

Query
subscription publicly_listed_security($filters: FilterPubliclyListedSecurity) {
  publicly_listed_security(filters: $filters) {
    entity_cik
    exchange
    ticker
  }
}
Variables
{"filters": FilterPubliclyListedSecurity}
Response
{
  "data": {
    "publicly_listed_security": {
      "entity_cik": 987,
      "exchange": "abc123",
      "ticker": "abc123"
    }
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

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

Entity

Fields
Field Name Description
business_address_city - String
business_address_state_or_country - String
business_address_state_or_country_description - String
business_address_street_1 - String
business_address_street_2 - String
business_address_zip_code - String
category - String
cik - Int
description - String
ein - String
entity_type - String
exchanges - [String!]
fiscal_year_end - String
flags - String
insider_transaction_for_issuer_exists - Boolean
insider_transaction_for_owner_exists - Boolean
investor_website - String
mailing_address_city - String
mailing_address_state_or_country - String
mailing_address_state_or_country_description - String
mailing_address_street_1 - String
mailing_address_street_2 - String
mailing_address_zip_code - String
name - String
phone - String
sic - String
sic_description - String
state_of_incorporation - String
state_of_incorporation_description - String
tickers - [String!]
website - String
Example
{
  "business_address_city": "xyz789",
  "business_address_state_or_country": "abc123",
  "business_address_state_or_country_description": "xyz789",
  "business_address_street_1": "xyz789",
  "business_address_street_2": "abc123",
  "business_address_zip_code": "abc123",
  "category": "abc123",
  "cik": 123,
  "description": "abc123",
  "ein": "abc123",
  "entity_type": "abc123",
  "exchanges": ["abc123"],
  "fiscal_year_end": "xyz789",
  "flags": "abc123",
  "insider_transaction_for_issuer_exists": true,
  "insider_transaction_for_owner_exists": true,
  "investor_website": "xyz789",
  "mailing_address_city": "xyz789",
  "mailing_address_state_or_country": "xyz789",
  "mailing_address_state_or_country_description": "xyz789",
  "mailing_address_street_1": "xyz789",
  "mailing_address_street_2": "abc123",
  "mailing_address_zip_code": "xyz789",
  "name": "abc123",
  "phone": "xyz789",
  "sic": "abc123",
  "sic_description": "abc123",
  "state_of_incorporation": "xyz789",
  "state_of_incorporation_description": "abc123",
  "tickers": ["abc123"],
  "website": "abc123"
}
Types

Filing

Fields
Field Name Description
acceptance_datetime - DateTime
accession_number - Int
entity_cik - Int
file_number - String
filing_date - NaiveDate
film_number - String
filing_index_url - String
form_type - String
is_from_feed - Boolean
primary_document_description - String
primary_document_name - String
report_date - NaiveDate
Example
{
  "acceptance_datetime": "2007-12-03T10:15:30Z",
  "accession_number": 123,
  "entity_cik": 123,
  "file_number": "abc123",
  "filing_date": NaiveDate,
  "film_number": "abc123",
  "filing_index_url": "xyz789",
  "form_type": "abc123",
  "is_from_feed": false,
  "primary_document_description": "xyz789",
  "primary_document_name": "abc123",
  "report_date": NaiveDate
}
Types

FilterEntity

Fields
Input Field Description
business_address_city - String
business_address_state_or_country - String
business_address_state_or_country_description - String
business_address_street_1 - String
business_address_street_2 - String
business_address_zip_code - String
category - String
cik - FilterableI64
description - String
ein - String
entity_type - String
exchanges - [String!]
fiscal_year_end - String
flags - String
insider_transaction_for_issuer_exists - Boolean
insider_transaction_for_owner_exists - Boolean
investor_website - String
mailing_address_city - String
mailing_address_state_or_country - String
mailing_address_state_or_country_description - String
mailing_address_street_1 - String
mailing_address_street_2 - String
mailing_address_zip_code - String
name - String
phone - String
sic - String
sic_description - String
state_of_incorporation - String
state_of_incorporation_description - String
tickers - [String!]
website - String
Example
{
  "business_address_city": "abc123",
  "business_address_state_or_country": "abc123",
  "business_address_state_or_country_description": "xyz789",
  "business_address_street_1": "xyz789",
  "business_address_street_2": "xyz789",
  "business_address_zip_code": "abc123",
  "category": "abc123",
  "cik": FilterableI64,
  "description": "abc123",
  "ein": "abc123",
  "entity_type": "abc123",
  "exchanges": ["abc123"],
  "fiscal_year_end": "xyz789",
  "flags": "xyz789",
  "insider_transaction_for_issuer_exists": true,
  "insider_transaction_for_owner_exists": false,
  "investor_website": "xyz789",
  "mailing_address_city": "abc123",
  "mailing_address_state_or_country": "xyz789",
  "mailing_address_state_or_country_description": "abc123",
  "mailing_address_street_1": "xyz789",
  "mailing_address_street_2": "abc123",
  "mailing_address_zip_code": "abc123",
  "name": "xyz789",
  "phone": "xyz789",
  "sic": "xyz789",
  "sic_description": "abc123",
  "state_of_incorporation": "xyz789",
  "state_of_incorporation_description": "abc123",
  "tickers": ["xyz789"],
  "website": "xyz789"
}
Types

FilterFiling

Fields
Input Field Description
acceptance_datetime - FilterableDateTime
accession_number - FilterableI64
entity_cik - FilterableI64
file_number - String
filing_date - FilterableNaiveDate
film_number - String
form_type - String
is_from_feed - Boolean
filing_index_url - String
primary_document_description - String
primary_document_name - String
report_date - FilterableNaiveDate
Example
{
  "acceptance_datetime": FilterableDateTime,
  "accession_number": FilterableI64,
  "entity_cik": FilterableI64,
  "file_number": "abc123",
  "filing_date": FilterableNaiveDate,
  "film_number": "abc123",
  "form_type": "xyz789",
  "is_from_feed": false,
  "filing_index_url": "abc123",
  "primary_document_description": "xyz789",
  "primary_document_name": "xyz789",
  "report_date": FilterableNaiveDate
}
Types

FilterFormerName

Fields
Input Field Description
cik - FilterableI64
from_datetime - FilterableDateTime
name - String
to_datetime - FilterableDateTime
Example
{
  "cik": FilterableI64,
  "from_datetime": FilterableDateTime,
  "name": "xyz789",
  "to_datetime": FilterableDateTime
}
Types

FilterPubliclyListedSecurity

Fields
Input Field Description
entity_cik - FilterableI64
exchange - String
ticker - String
Example
{
  "entity_cik": FilterableI64,
  "exchange": "abc123",
  "ticker": "xyz789"
}
Types

FilterableDateTime

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

FilterableI64

Fields
Input Field Description
equal - Int
range - I64Range
Example
{"equal": 123, "range": I64Range}
Types

FilterableNaiveDate

Fields
Input Field Description
equal - NaiveDate
range - NaiveDateRange
Example
{
  "equal": NaiveDate,
  "range": NaiveDateRange
}
Types

FormerName

Fields
Field Name Description
cik - Int
from_datetime - DateTime
name - String
to_datetime - DateTime
Example
{
  "cik": 123,
  "from_datetime": "2007-12-03T10:15:30Z",
  "name": "xyz789",
  "to_datetime": "2007-12-03T10:15:30Z"
}
Types

I64HighEnd

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

I64LowEnd

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

I64Range

Fields
Input Field Description
lowEnd - I64LowEnd
highEnd - I64HighEnd
Example
{
  "lowEnd": I64LowEnd,
  "highEnd": I64HighEnd
}
Types

Int

Description

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

Example
987
Types

NaiveDate

Description

ISO 8601 calendar date without timezone. Format: %Y-%m-%d

Examples

  • 1994-11-13
  • 2000-02-24
Example
NaiveDate
Types

NaiveDateHighEnd

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

NaiveDateLowEnd

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

NaiveDateRange

Fields
Input Field Description
lowEnd - NaiveDateLowEnd
highEnd - NaiveDateHighEnd
Example
{
  "lowEnd": NaiveDateLowEnd,
  "highEnd": NaiveDateHighEnd
}
Types

PubliclyListedSecurity

Fields
Field Name Description
entity_cik - Int
exchange - String
ticker - String
Example
{
  "entity_cik": 123,
  "exchange": "xyz789",
  "ticker": "abc123"
}
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
"abc123"
Documentation by Anvil SpectaQL