SEC EDGAR Form 3, 3/A 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.

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

Queries

`derivative_holding`

Response

Returns [Form3DerivativeHolding!]!

Arguments

Name	Description
`offset` - `Int`
`filters` - `FilterForm3DerivativeHolding`

Example

Query

query derivative_holding(
  $offset: Int,
  $filters: FilterForm3DerivativeHolding
) {
  derivative_holding(
    offset: $offset,
    filters: $filters
  ) {
    conversion_or_exercise_price
    conversion_or_exercise_price_footnote_ids
    direct_or_indirect_ownership
    direct_or_indirect_ownership_footnote_ids
    entity_cik
    exercise_date
    exercise_date_footnote_ids
    expiration_date
    expiration_date_footnote_ids
    filing_accession_number
    line_number
    nature_of_ownership
    nature_of_ownership_footnote_ids
    security_title
    security_title_footnote_ids
    underlying_security_shares
    underlying_security_shares_footnote_ids
    underlying_security_title
    underlying_security_title_footnote_ids
    underlying_security_value
    underlying_security_value_footnote_ids
  }
}

Variables

{"offset": 123, "filters": FilterForm3DerivativeHolding}

Response

{
  "data": {
    "derivative_holding": [
      {
        "conversion_or_exercise_price": 987.65,
        "conversion_or_exercise_price_footnote_ids": [
          "xyz789"
        ],
        "direct_or_indirect_ownership": "xyz789",
        "direct_or_indirect_ownership_footnote_ids": [
          "xyz789"
        ],
        "entity_cik": 123,
        "exercise_date": NaiveDate,
        "exercise_date_footnote_ids": [
          "xyz789"
        ],
        "expiration_date": NaiveDate,
        "expiration_date_footnote_ids": [
          "xyz789"
        ],
        "filing_accession_number": 123,
        "line_number": 987,
        "nature_of_ownership": "xyz789",
        "nature_of_ownership_footnote_ids": [
          "xyz789"
        ],
        "security_title": "abc123",
        "security_title_footnote_ids": [
          "xyz789"
        ],
        "underlying_security_shares": 123.45,
        "underlying_security_shares_footnote_ids": [
          "xyz789"
        ],
        "underlying_security_title": "abc123",
        "underlying_security_title_footnote_ids": [
          "xyz789"
        ],
        "underlying_security_value": 987.65,
        "underlying_security_value_footnote_ids": [
          "xyz789"
        ]
      }
    ]
  }
}

Queries

`derivative_holding_count`

Response

Returns an Int!

Arguments

Name	Description
`filters` - `FilterForm3DerivativeHolding`

Example

Query

query derivative_holding_count($filters: FilterForm3DerivativeHolding) {
  derivative_holding_count(filters: $filters)
}

Variables

{"filters": FilterForm3DerivativeHolding}

Response

{"data": {"derivative_holding_count": 987}}

Queries

`footnote`

Response

Returns [Form3Footnote!]!

Arguments

Name	Description
`offset` - `Int`
`filters` - `FilterForm3Footnote`

Example

Query

query footnote(
  $offset: Int,
  $filters: FilterForm3Footnote
) {
  footnote(
    offset: $offset,
    filters: $filters
  ) {
    entity_cik
    filing_accession_number
    footnote_id
    pos
    value
  }
}

Variables

{"offset": 987, "filters": FilterForm3Footnote}

Response

{
  "data": {
    "footnote": [
      {
        "entity_cik": 123,
        "filing_accession_number": 123,
        "footnote_id": "abc123",
        "pos": 987,
        "value": "xyz789"
      }
    ]
  }
}

Queries

`footnote_count`

Response

Returns an Int!

Arguments

Name	Description
`filters` - `FilterForm3Footnote`

Example

Query

query footnote_count($filters: FilterForm3Footnote) {
  footnote_count(filters: $filters)
}

Variables

{"filters": FilterForm3Footnote}

Response

{"data": {"footnote_count": 987}}

Queries

`issuer`

Response

Returns [Form3Issuer!]!

Arguments

Name	Description
`offset` - `Int`
`filters` - `FilterForm3Issuer`

Example

Query

query issuer(
  $offset: Int,
  $filters: FilterForm3Issuer
) {
  issuer(
    offset: $offset,
    filters: $filters
  ) {
    cik
    entity_cik
    filing_accession_number
    name
    trading_symbols
  }
}

Variables

{"offset": 987, "filters": FilterForm3Issuer}

Response

{
  "data": {
    "issuer": [
      {
        "cik": 987,
        "entity_cik": 987,
        "filing_accession_number": 987,
        "name": "abc123",
        "trading_symbols": ["xyz789"]
      }
    ]
  }
}

Queries

`issuer_count`

Response

Returns an Int!

Arguments

Name	Description
`filters` - `FilterForm3Issuer`

Example

Query

query issuer_count($filters: FilterForm3Issuer) {
  issuer_count(filters: $filters)
}

Variables

{"filters": FilterForm3Issuer}

Response

{"data": {"issuer_count": 987}}

Queries

`metadata`

Response

Returns [Form3Metadata!]!

Arguments

Name	Description
`offset` - `Int`
`filters` - `FilterForm3Metadata`

Example

Query

query metadata(
  $offset: Int,
  $filters: FilterForm3Metadata
) {
  metadata(
    offset: $offset,
    filters: $filters
  ) {
    date_of_original_submission
    document_type
    filing_accession_number
    not_subject_to_section_16
    period_of_report
    schema_version
  }
}

Variables

{"offset": 123, "filters": FilterForm3Metadata}

Response

{
  "data": {
    "metadata": [
      {
        "date_of_original_submission": NaiveDate,
        "document_type": "abc123",
        "filing_accession_number": 123,
        "not_subject_to_section_16": false,
        "period_of_report": "abc123",
        "schema_version": "xyz789"
      }
    ]
  }
}

Queries

`metadata_count`

Response

Returns an Int!

Arguments

Name	Description
`filters` - `FilterForm3Metadata`

Example

Query

query metadata_count($filters: FilterForm3Metadata) {
  metadata_count(filters: $filters)
}

Variables

{"filters": FilterForm3Metadata}

Response

{"data": {"metadata_count": 123}}

Queries

`non_derivative_holding`

Response

Returns [Form3NonDerivativeHolding!]!

Arguments

Name	Description
`offset` - `Int`
`filters` - `FilterForm3NonDerivativeHolding`

Example

Query

query non_derivative_holding(
  $offset: Int,
  $filters: FilterForm3NonDerivativeHolding
) {
  non_derivative_holding(
    offset: $offset,
    filters: $filters
  ) {
    direct_or_indirect_ownership
    direct_or_indirect_ownership_footnote_ids
    entity_cik
    filing_accession_number
    line_number
    nature_of_ownership
    nature_of_ownership_footnote_ids
    security_title
    security_title_footnote_ids
    shares_owned_following_transaction
    shares_owned_following_transaction_footnote_ids
    value_owned_following_transaction
    value_owned_following_transaction_footnote_ids
  }
}

Variables

{
  "offset": 987,
  "filters": FilterForm3NonDerivativeHolding
}

Response

{
  "data": {
    "non_derivative_holding": [
      {
        "direct_or_indirect_ownership": "xyz789",
        "direct_or_indirect_ownership_footnote_ids": [
          "xyz789"
        ],
        "entity_cik": 987,
        "filing_accession_number": 123,
        "line_number": 987,
        "nature_of_ownership": "abc123",
        "nature_of_ownership_footnote_ids": [
          "abc123"
        ],
        "security_title": "xyz789",
        "security_title_footnote_ids": [
          "abc123"
        ],
        "shares_owned_following_transaction": 123.45,
        "shares_owned_following_transaction_footnote_ids": [
          "xyz789"
        ],
        "value_owned_following_transaction": 123.45,
        "value_owned_following_transaction_footnote_ids": [
          "abc123"
        ]
      }
    ]
  }
}

Queries

`non_derivative_holding_count`

Response

Returns an Int!

Arguments

Name	Description
`filters` - `FilterForm3NonDerivativeHolding`

Example

Query

query non_derivative_holding_count($filters: FilterForm3NonDerivativeHolding) {
  non_derivative_holding_count(filters: $filters)
}

Variables

{"filters": FilterForm3NonDerivativeHolding}

Response

{"data": {"non_derivative_holding_count": 987}}

Queries

`owner_signature`

Response

Returns [Form3OwnerSignature!]!

Arguments

Name	Description
`offset` - `Int`
`filters` - `FilterForm3OwnerSignature`

Example

Query

query owner_signature(
  $offset: Int,
  $filters: FilterForm3OwnerSignature
) {
  owner_signature(
    offset: $offset,
    filters: $filters
  ) {
    entity_cik
    filing_accession_number
    pos
    signature_date
    signature_name
  }
}

Variables

{"offset": 123, "filters": FilterForm3OwnerSignature}

Response

{
  "data": {
    "owner_signature": [
      {
        "entity_cik": 123,
        "filing_accession_number": 123,
        "pos": 123,
        "signature_date": NaiveDate,
        "signature_name": "xyz789"
      }
    ]
  }
}

Queries

`owner_signature_count`

Response

Returns an Int!

Arguments

Name	Description
`filters` - `FilterForm3OwnerSignature`

Example

Query

query owner_signature_count($filters: FilterForm3OwnerSignature) {
  owner_signature_count(filters: $filters)
}

Variables

{"filters": FilterForm3OwnerSignature}

Response

{"data": {"owner_signature_count": 123}}

Queries

`remarks`

Response

Returns [Form3Remarks!]!

Arguments

Name	Description
`offset` - `Int`
`filters` - `FilterForm3Remarks`

Example

Query

query remarks(
  $offset: Int,
  $filters: FilterForm3Remarks
) {
  remarks(
    offset: $offset,
    filters: $filters
  ) {
    entity_cik
    filing_accession_number
    remarks
  }
}

Variables

{"offset": 987, "filters": FilterForm3Remarks}

Response

{
  "data": {
    "remarks": [
      {
        "entity_cik": 123,
        "filing_accession_number": 987,
        "remarks": "xyz789"
      }
    ]
  }
}

Queries

`remarks_count`

Response

Returns an Int!

Arguments

Name	Description
`filters` - `FilterForm3Remarks`

Example

Query

query remarks_count($filters: FilterForm3Remarks) {
  remarks_count(filters: $filters)
}

Variables

{"filters": FilterForm3Remarks}

Response

{"data": {"remarks_count": 123}}

Queries

`reporting_owner`

Response

Returns [Form3ReportingOwner!]!

Arguments

Name	Description
`offset` - `Int`
`filters` - `FilterForm3ReportingOwner`

Example

Query

query reporting_owner(
  $offset: Int,
  $filters: FilterForm3ReportingOwner
) {
  reporting_owner(
    offset: $offset,
    filters: $filters
  ) {
    cik
    city
    entity_cik
    filing_accession_number
    is_director
    is_officer
    is_other
    is_ten_percent_owner
    name
    officer_title
    other_text
    pos
    state
    state_description
    street_1
    street_2
    zip_code
  }
}

Variables

{"offset": 123, "filters": FilterForm3ReportingOwner}

Response

{
  "data": {
    "reporting_owner": [
      {
        "cik": 987,
        "city": "abc123",
        "entity_cik": 123,
        "filing_accession_number": 987,
        "is_director": false,
        "is_officer": true,
        "is_other": true,
        "is_ten_percent_owner": false,
        "name": "xyz789",
        "officer_title": "xyz789",
        "other_text": "xyz789",
        "pos": 123,
        "state": "abc123",
        "state_description": "abc123",
        "street_1": "xyz789",
        "street_2": "xyz789",
        "zip_code": "abc123"
      }
    ]
  }
}

Queries

`reporting_owner_count`

Response

Returns an Int!

Arguments

Name	Description
`filters` - `FilterForm3ReportingOwner`

Example

Query

query reporting_owner_count($filters: FilterForm3ReportingOwner) {
  reporting_owner_count(filters: $filters)
}

Variables

{"filters": FilterForm3ReportingOwner}

Response

{"data": {"reporting_owner_count": 123}}

Subscriptions

`derivative_holding`

Response

Returns a Form3DerivativeHolding!

Arguments

Name	Description
`filters` - `FilterForm3DerivativeHolding`

Example

Query

subscription derivative_holding($filters: FilterForm3DerivativeHolding) {
  derivative_holding(filters: $filters) {
    conversion_or_exercise_price
    conversion_or_exercise_price_footnote_ids
    direct_or_indirect_ownership
    direct_or_indirect_ownership_footnote_ids
    entity_cik
    exercise_date
    exercise_date_footnote_ids
    expiration_date
    expiration_date_footnote_ids
    filing_accession_number
    line_number
    nature_of_ownership
    nature_of_ownership_footnote_ids
    security_title
    security_title_footnote_ids
    underlying_security_shares
    underlying_security_shares_footnote_ids
    underlying_security_title
    underlying_security_title_footnote_ids
    underlying_security_value
    underlying_security_value_footnote_ids
  }
}

Variables

{"filters": FilterForm3DerivativeHolding}

Response

{
  "data": {
    "derivative_holding": {
      "conversion_or_exercise_price": 123.45,
      "conversion_or_exercise_price_footnote_ids": [
        "abc123"
      ],
      "direct_or_indirect_ownership": "abc123",
      "direct_or_indirect_ownership_footnote_ids": [
        "abc123"
      ],
      "entity_cik": 123,
      "exercise_date": NaiveDate,
      "exercise_date_footnote_ids": [
        "abc123"
      ],
      "expiration_date": NaiveDate,
      "expiration_date_footnote_ids": [
        "xyz789"
      ],
      "filing_accession_number": 987,
      "line_number": 987,
      "nature_of_ownership": "xyz789",
      "nature_of_ownership_footnote_ids": [
        "xyz789"
      ],
      "security_title": "xyz789",
      "security_title_footnote_ids": [
        "xyz789"
      ],
      "underlying_security_shares": 987.65,
      "underlying_security_shares_footnote_ids": [
        "xyz789"
      ],
      "underlying_security_title": "xyz789",
      "underlying_security_title_footnote_ids": [
        "xyz789"
      ],
      "underlying_security_value": 123.45,
      "underlying_security_value_footnote_ids": [
        "abc123"
      ]
    }
  }
}

Subscriptions

`footnote`

Response

Returns a Form3Footnote!

Arguments

Name	Description
`filters` - `FilterForm3Footnote`

Example

Query

subscription footnote($filters: FilterForm3Footnote) {
  footnote(filters: $filters) {
    entity_cik
    filing_accession_number
    footnote_id
    pos
    value
  }
}

Variables

{"filters": FilterForm3Footnote}

Response

{
  "data": {
    "footnote": {
      "entity_cik": 987,
      "filing_accession_number": 987,
      "footnote_id": "xyz789",
      "pos": 987,
      "value": "abc123"
    }
  }
}

Subscriptions

`issuer`

Response

Returns a Form3Issuer!

Arguments

Name	Description
`filters` - `FilterForm3Issuer`

Example

Query

subscription issuer($filters: FilterForm3Issuer) {
  issuer(filters: $filters) {
    cik
    entity_cik
    filing_accession_number
    name
    trading_symbols
  }
}

Variables

{"filters": FilterForm3Issuer}

Response

{
  "data": {
    "issuer": {
      "cik": 987,
      "entity_cik": 123,
      "filing_accession_number": 123,
      "name": "abc123",
      "trading_symbols": ["xyz789"]
    }
  }
}

Subscriptions

`metadata`

Response

Returns a Form3Metadata!

Arguments

Name	Description
`filters` - `FilterForm3Metadata`

Example

Query

subscription metadata($filters: FilterForm3Metadata) {
  metadata(filters: $filters) {
    date_of_original_submission
    document_type
    filing_accession_number
    not_subject_to_section_16
    period_of_report
    schema_version
  }
}

Variables

{"filters": FilterForm3Metadata}

Response

{
  "data": {
    "metadata": {
      "date_of_original_submission": NaiveDate,
      "document_type": "abc123",
      "filing_accession_number": 987,
      "not_subject_to_section_16": true,
      "period_of_report": "abc123",
      "schema_version": "abc123"
    }
  }
}

Subscriptions

`non_derivative_holding`

Response

Returns a Form3NonDerivativeHolding!

Arguments

Name	Description
`filters` - `FilterForm3NonDerivativeHolding`

Example

Query

subscription non_derivative_holding($filters: FilterForm3NonDerivativeHolding) {
  non_derivative_holding(filters: $filters) {
    direct_or_indirect_ownership
    direct_or_indirect_ownership_footnote_ids
    entity_cik
    filing_accession_number
    line_number
    nature_of_ownership
    nature_of_ownership_footnote_ids
    security_title
    security_title_footnote_ids
    shares_owned_following_transaction
    shares_owned_following_transaction_footnote_ids
    value_owned_following_transaction
    value_owned_following_transaction_footnote_ids
  }
}

Variables

{"filters": FilterForm3NonDerivativeHolding}

Response

{
  "data": {
    "non_derivative_holding": {
      "direct_or_indirect_ownership": "xyz789",
      "direct_or_indirect_ownership_footnote_ids": [
        "xyz789"
      ],
      "entity_cik": 123,
      "filing_accession_number": 987,
      "line_number": 123,
      "nature_of_ownership": "xyz789",
      "nature_of_ownership_footnote_ids": [
        "xyz789"
      ],
      "security_title": "xyz789",
      "security_title_footnote_ids": [
        "abc123"
      ],
      "shares_owned_following_transaction": 987.65,
      "shares_owned_following_transaction_footnote_ids": [
        "xyz789"
      ],
      "value_owned_following_transaction": 123.45,
      "value_owned_following_transaction_footnote_ids": [
        "abc123"
      ]
    }
  }
}

Subscriptions

`owner_signature`

Response

Returns a Form3OwnerSignature!

Arguments

Name	Description
`filters` - `FilterForm3OwnerSignature`

Example

Query

subscription owner_signature($filters: FilterForm3OwnerSignature) {
  owner_signature(filters: $filters) {
    entity_cik
    filing_accession_number
    pos
    signature_date
    signature_name
  }
}

Variables

{"filters": FilterForm3OwnerSignature}

Response

{
  "data": {
    "owner_signature": {
      "entity_cik": 123,
      "filing_accession_number": 123,
      "pos": 987,
      "signature_date": NaiveDate,
      "signature_name": "abc123"
    }
  }
}

Subscriptions

`remarks`

Response

Returns a Form3Remarks!

Arguments

Name	Description
`filters` - `FilterForm3Remarks`

Example

Query

subscription remarks($filters: FilterForm3Remarks) {
  remarks(filters: $filters) {
    entity_cik
    filing_accession_number
    remarks
  }
}

Variables

{"filters": FilterForm3Remarks}

Response

{
  "data": {
    "remarks": {
      "entity_cik": 123,
      "filing_accession_number": 987,
      "remarks": "abc123"
    }
  }
}

Subscriptions

`reporting_owner`

Response

Returns a Form3ReportingOwner!

Arguments

Name	Description
`filters` - `FilterForm3ReportingOwner`

Example

Query

subscription reporting_owner($filters: FilterForm3ReportingOwner) {
  reporting_owner(filters: $filters) {
    cik
    city
    entity_cik
    filing_accession_number
    is_director
    is_officer
    is_other
    is_ten_percent_owner
    name
    officer_title
    other_text
    pos
    state
    state_description
    street_1
    street_2
    zip_code
  }
}

Variables

{"filters": FilterForm3ReportingOwner}

Response

{
  "data": {
    "reporting_owner": {
      "cik": 123,
      "city": "xyz789",
      "entity_cik": 987,
      "filing_accession_number": 987,
      "is_director": false,
      "is_officer": true,
      "is_other": true,
      "is_ten_percent_owner": true,
      "name": "abc123",
      "officer_title": "abc123",
      "other_text": "xyz789",
      "pos": 123,
      "state": "abc123",
      "state_description": "xyz789",
      "street_1": "xyz789",
      "street_2": "abc123",
      "zip_code": "xyz789"
    }
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example

true

Types

F64HighEnd

Fields

Input Field	Description
`le` - `Float`
`lt` - `Float`

Example

{"le": 987.65, "lt": 987.65}

Types

F64LowEnd

Fields

Input Field	Description
`ge` - `Float`
`gt` - `Float`

Example

{"ge": 123.45, "gt": 123.45}

Types

F64Range

Fields

Input Field	Description
`lowEnd` - `F64LowEnd`
`highEnd` - `F64HighEnd`

Example

{
  "lowEnd": F64LowEnd,
  "highEnd": F64HighEnd
}

Types

FilterForm3DerivativeHolding

Fields

Input Field	Description
`conversion_or_exercise_price` - `FilterableF64`
`conversion_or_exercise_price_footnote_ids` - `[String!]`
`direct_or_indirect_ownership` - `String`
`direct_or_indirect_ownership_footnote_ids` - `[String!]`
`entity_cik` - `FilterableI64`
`exercise_date` - `FilterableNaiveDate`
`exercise_date_footnote_ids` - `[String!]`
`expiration_date` - `FilterableNaiveDate`
`expiration_date_footnote_ids` - `[String!]`
`filing_accession_number` - `FilterableI64`
`line_number` - `FilterableI32`
`nature_of_ownership` - `String`
`nature_of_ownership_footnote_ids` - `[String!]`
`security_title` - `String`
`security_title_footnote_ids` - `[String!]`
`underlying_security_shares` - `FilterableF64`
`underlying_security_shares_footnote_ids` - `[String!]`
`underlying_security_title` - `String`
`underlying_security_title_footnote_ids` - `[String!]`
`underlying_security_value` - `FilterableF64`
`underlying_security_value_footnote_ids` - `[String!]`

Example

{
  "conversion_or_exercise_price": FilterableF64,
  "conversion_or_exercise_price_footnote_ids": [
    "xyz789"
  ],
  "direct_or_indirect_ownership": "abc123",
  "direct_or_indirect_ownership_footnote_ids": [
    "abc123"
  ],
  "entity_cik": FilterableI64,
  "exercise_date": FilterableNaiveDate,
  "exercise_date_footnote_ids": ["abc123"],
  "expiration_date": FilterableNaiveDate,
  "expiration_date_footnote_ids": [
    "abc123"
  ],
  "filing_accession_number": FilterableI64,
  "line_number": FilterableI32,
  "nature_of_ownership": "xyz789",
  "nature_of_ownership_footnote_ids": [
    "abc123"
  ],
  "security_title": "xyz789",
  "security_title_footnote_ids": ["abc123"],
  "underlying_security_shares": FilterableF64,
  "underlying_security_shares_footnote_ids": [
    "xyz789"
  ],
  "underlying_security_title": "xyz789",
  "underlying_security_title_footnote_ids": [
    "abc123"
  ],
  "underlying_security_value": FilterableF64,
  "underlying_security_value_footnote_ids": [
    "abc123"
  ]
}

Types

FilterForm3Footnote

Fields

Input Field	Description
`entity_cik` - `FilterableI64`
`filing_accession_number` - `FilterableI64`
`footnote_id` - `String`
`pos` - `FilterableI32`
`value` - `String`

Example

{
  "entity_cik": FilterableI64,
  "filing_accession_number": FilterableI64,
  "footnote_id": "abc123",
  "pos": FilterableI32,
  "value": "abc123"
}

Types

FilterForm3Issuer

Fields

Input Field	Description
`cik` - `FilterableI64`
`entity_cik` - `FilterableI64`
`filing_accession_number` - `FilterableI64`
`name` - `String`
`trading_symbols` - `[String!]`

Example

{
  "cik": FilterableI64,
  "entity_cik": FilterableI64,
  "filing_accession_number": FilterableI64,
  "name": "abc123",
  "trading_symbols": ["abc123"]
}

Types

FilterForm3Metadata

Fields

Input Field	Description
`date_of_original_submission` - `FilterableNaiveDate`
`document_type` - `String`
`filing_accession_number` - `FilterableI64`
`not_subject_to_section_16` - `Boolean`
`period_of_report` - `String`
`schema_version` - `String`

Example

{
  "date_of_original_submission": FilterableNaiveDate,
  "document_type": "xyz789",
  "filing_accession_number": FilterableI64,
  "not_subject_to_section_16": false,
  "period_of_report": "xyz789",
  "schema_version": "xyz789"
}

Types

FilterForm3NonDerivativeHolding

Fields

Input Field	Description
`direct_or_indirect_ownership` - `String`
`direct_or_indirect_ownership_footnote_ids` - `[String!]`
`entity_cik` - `FilterableI64`
`filing_accession_number` - `FilterableI64`
`line_number` - `FilterableI32`
`nature_of_ownership` - `String`
`nature_of_ownership_footnote_ids` - `[String!]`
`security_title` - `String`
`security_title_footnote_ids` - `[String!]`
`shares_owned_following_transaction` - `FilterableF64`
`shares_owned_following_transaction_footnote_ids` - `[String!]`
`value_owned_following_transaction` - `FilterableF64`
`value_owned_following_transaction_footnote_ids` - `[String!]`

Example

{
  "direct_or_indirect_ownership": "abc123",
  "direct_or_indirect_ownership_footnote_ids": [
    "xyz789"
  ],
  "entity_cik": FilterableI64,
  "filing_accession_number": FilterableI64,
  "line_number": FilterableI32,
  "nature_of_ownership": "abc123",
  "nature_of_ownership_footnote_ids": [
    "xyz789"
  ],
  "security_title": "abc123",
  "security_title_footnote_ids": ["xyz789"],
  "shares_owned_following_transaction": FilterableF64,
  "shares_owned_following_transaction_footnote_ids": [
    "abc123"
  ],
  "value_owned_following_transaction": FilterableF64,
  "value_owned_following_transaction_footnote_ids": [
    "abc123"
  ]
}

Types

FilterForm3OwnerSignature

Fields

Input Field	Description
`entity_cik` - `FilterableI64`
`filing_accession_number` - `FilterableI64`
`pos` - `FilterableI32`
`signature_date` - `FilterableNaiveDate`
`signature_name` - `String`

Example

{
  "entity_cik": FilterableI64,
  "filing_accession_number": FilterableI64,
  "pos": FilterableI32,
  "signature_date": FilterableNaiveDate,
  "signature_name": "abc123"
}

Types

FilterForm3Remarks

Fields

Input Field	Description
`entity_cik` - `FilterableI64`
`filing_accession_number` - `FilterableI64`
`remarks` - `String`

Example

{
  "entity_cik": FilterableI64,
  "filing_accession_number": FilterableI64,
  "remarks": "abc123"
}

Types

FilterForm3ReportingOwner

Fields

Input Field	Description
`cik` - `FilterableI64`
`city` - `String`
`entity_cik` - `FilterableI64`
`filing_accession_number` - `FilterableI64`
`is_director` - `Boolean`
`is_officer` - `Boolean`
`is_other` - `Boolean`
`is_ten_percent_owner` - `Boolean`
`name` - `String`
`officer_title` - `String`
`other_text` - `String`
`pos` - `FilterableI32`
`state` - `String`
`state_description` - `String`
`street_1` - `String`
`street_2` - `String`
`zip_code` - `String`

Example

{
  "cik": FilterableI64,
  "city": "abc123",
  "entity_cik": FilterableI64,
  "filing_accession_number": FilterableI64,
  "is_director": true,
  "is_officer": false,
  "is_other": false,
  "is_ten_percent_owner": false,
  "name": "xyz789",
  "officer_title": "xyz789",
  "other_text": "xyz789",
  "pos": FilterableI32,
  "state": "abc123",
  "state_description": "abc123",
  "street_1": "abc123",
  "street_2": "abc123",
  "zip_code": "xyz789"
}

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": 123, "range": I32Range}

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

Float

Description

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

Example

987.65

Types

Form3DerivativeHolding

Fields

Field Name	Description
`conversion_or_exercise_price` - `Float`
`conversion_or_exercise_price_footnote_ids` - `[String!]`
`direct_or_indirect_ownership` - `String`
`direct_or_indirect_ownership_footnote_ids` - `[String!]`
`entity_cik` - `Int`
`exercise_date` - `NaiveDate`
`exercise_date_footnote_ids` - `[String!]`
`expiration_date` - `NaiveDate`
`expiration_date_footnote_ids` - `[String!]`
`filing_accession_number` - `Int`
`line_number` - `Int`
`nature_of_ownership` - `String`
`nature_of_ownership_footnote_ids` - `[String!]`
`security_title` - `String`
`security_title_footnote_ids` - `[String!]`
`underlying_security_shares` - `Float`
`underlying_security_shares_footnote_ids` - `[String!]`
`underlying_security_title` - `String`
`underlying_security_title_footnote_ids` - `[String!]`
`underlying_security_value` - `Float`
`underlying_security_value_footnote_ids` - `[String!]`

Example

{
  "conversion_or_exercise_price": 987.65,
  "conversion_or_exercise_price_footnote_ids": [
    "abc123"
  ],
  "direct_or_indirect_ownership": "xyz789",
  "direct_or_indirect_ownership_footnote_ids": [
    "abc123"
  ],
  "entity_cik": 987,
  "exercise_date": NaiveDate,
  "exercise_date_footnote_ids": ["xyz789"],
  "expiration_date": NaiveDate,
  "expiration_date_footnote_ids": [
    "xyz789"
  ],
  "filing_accession_number": 987,
  "line_number": 123,
  "nature_of_ownership": "xyz789",
  "nature_of_ownership_footnote_ids": [
    "abc123"
  ],
  "security_title": "abc123",
  "security_title_footnote_ids": ["xyz789"],
  "underlying_security_shares": 123.45,
  "underlying_security_shares_footnote_ids": [
    "xyz789"
  ],
  "underlying_security_title": "abc123",
  "underlying_security_title_footnote_ids": [
    "abc123"
  ],
  "underlying_security_value": 987.65,
  "underlying_security_value_footnote_ids": [
    "xyz789"
  ]
}

Types

Form3Footnote

Fields

Field Name	Description
`entity_cik` - `Int`
`filing_accession_number` - `Int`
`footnote_id` - `String`
`pos` - `Int`
`value` - `String`

Example

{
  "entity_cik": 123,
  "filing_accession_number": 987,
  "footnote_id": "xyz789",
  "pos": 123,
  "value": "xyz789"
}

Types

Form3Issuer

Fields

Field Name	Description
`cik` - `Int`
`entity_cik` - `Int`
`filing_accession_number` - `Int`
`name` - `String`
`trading_symbols` - `[String!]`

Example

{
  "cik": 123,
  "entity_cik": 123,
  "filing_accession_number": 987,
  "name": "xyz789",
  "trading_symbols": ["xyz789"]
}

Types

Form3Metadata

Fields

Field Name	Description
`date_of_original_submission` - `NaiveDate`
`document_type` - `String`
`filing_accession_number` - `Int`
`not_subject_to_section_16` - `Boolean`
`period_of_report` - `String`
`schema_version` - `String`

Example

{
  "date_of_original_submission": NaiveDate,
  "document_type": "abc123",
  "filing_accession_number": 123,
  "not_subject_to_section_16": false,
  "period_of_report": "xyz789",
  "schema_version": "xyz789"
}

Types

Form3NonDerivativeHolding

Fields

Field Name	Description
`direct_or_indirect_ownership` - `String`
`direct_or_indirect_ownership_footnote_ids` - `[String!]`
`entity_cik` - `Int`
`filing_accession_number` - `Int`
`line_number` - `Int`
`nature_of_ownership` - `String`
`nature_of_ownership_footnote_ids` - `[String!]`
`security_title` - `String`
`security_title_footnote_ids` - `[String!]`
`shares_owned_following_transaction` - `Float`
`shares_owned_following_transaction_footnote_ids` - `[String!]`
`value_owned_following_transaction` - `Float`
`value_owned_following_transaction_footnote_ids` - `[String!]`

Example

{
  "direct_or_indirect_ownership": "xyz789",
  "direct_or_indirect_ownership_footnote_ids": [
    "abc123"
  ],
  "entity_cik": 987,
  "filing_accession_number": 123,
  "line_number": 987,
  "nature_of_ownership": "abc123",
  "nature_of_ownership_footnote_ids": [
    "abc123"
  ],
  "security_title": "xyz789",
  "security_title_footnote_ids": ["abc123"],
  "shares_owned_following_transaction": 123.45,
  "shares_owned_following_transaction_footnote_ids": [
    "xyz789"
  ],
  "value_owned_following_transaction": 123.45,
  "value_owned_following_transaction_footnote_ids": [
    "xyz789"
  ]
}

Types

Form3OwnerSignature

Fields

Field Name	Description
`entity_cik` - `Int`
`filing_accession_number` - `Int`
`pos` - `Int`
`signature_date` - `NaiveDate`
`signature_name` - `String`

Example

{
  "entity_cik": 987,
  "filing_accession_number": 987,
  "pos": 987,
  "signature_date": NaiveDate,
  "signature_name": "xyz789"
}

Types

Form3Remarks

Fields

Field Name	Description
`entity_cik` - `Int`
`filing_accession_number` - `Int`
`remarks` - `String`

Example

{
  "entity_cik": 987,
  "filing_accession_number": 123,
  "remarks": "xyz789"
}

Types

Form3ReportingOwner

Fields

Field Name	Description
`cik` - `Int`
`city` - `String`
`entity_cik` - `Int`
`filing_accession_number` - `Int`
`is_director` - `Boolean`
`is_officer` - `Boolean`
`is_other` - `Boolean`
`is_ten_percent_owner` - `Boolean`
`name` - `String`
`officer_title` - `String`
`other_text` - `String`
`pos` - `Int`
`state` - `String`
`state_description` - `String`
`street_1` - `String`
`street_2` - `String`
`zip_code` - `String`

Example

{
  "cik": 987,
  "city": "xyz789",
  "entity_cik": 987,
  "filing_accession_number": 987,
  "is_director": false,
  "is_officer": true,
  "is_other": false,
  "is_ten_percent_owner": true,
  "name": "xyz789",
  "officer_title": "abc123",
  "other_text": "xyz789",
  "pos": 123,
  "state": "xyz789",
  "state_description": "abc123",
  "street_1": "abc123",
  "street_2": "abc123",
  "zip_code": "xyz789"
}

Types

I32HighEnd

Fields

Input Field	Description
`le` - `Int`
`lt` - `Int`

Example

{"le": 123, "lt": 987}

Types

I32LowEnd

Fields

Input Field	Description
`ge` - `Int`
`gt` - `Int`

Example

{"ge": 123, "gt": 987}

Types

I32Range

Fields

Input Field	Description
`lowEnd` - `I32LowEnd`
`highEnd` - `I32HighEnd`

Example

{
  "lowEnd": I32LowEnd,
  "highEnd": I32HighEnd
}

Types

I64HighEnd

Fields

Input Field	Description
`le` - `Int`
`lt` - `Int`

Example

{"le": 987, "lt": 123}

Types

I64LowEnd

Fields

Input Field	Description
`ge` - `Int`
`gt` - `Int`

Example

{"ge": 123, "gt": 987}

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

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

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"

Documentation by Anvil SpectaQL