Class V1SecFilingParams
-
- All Implemented Interfaces:
-
dev.case.api.core.Params
public final class V1SecFilingParams implements Params
Search SEC EDGAR full-text filings via efts.sec.gov or fetch a filer's structured filing history via data.sec.gov. Returns direct SEC archive URLs with filing metadata and match snippets when available.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classV1SecFilingParams.BuilderA builder for V1SecFilingParams.
public final classV1SecFilingParams.Bodypublic final classV1SecFilingParams.TypeRun a full-text search or fetch a single entity filing history
-
Method Summary
Modifier and Type Method Description final V1SecFilingParams.Typetype()Run a full-text search or fetch a single entity filing history final Optional<String>cik()CIK for entity lookups. final Optional<LocalDate>dateAfter()Optional lower filing date bound (YYYY-MM-DD) final Optional<LocalDate>dateBefore()Optional upper filing date bound (YYYY-MM-DD) final Optional<String>entity()Optional entity filter passed through to EDGAR full-text search final Optional<List<String>>formTypes()Optional SEC form type filter such as 10-K, 10-Q, 8-K, or 4 final Optional<Long>limit()Maximum filings to return final Optional<Long>offset()Result offset for pagination final Optional<String>query()Full-text SEC search query (required for type: search) final Optional<String>ticker()Optional company ticker. final JsonField<V1SecFilingParams.Type>_type()Returns the raw JSON value of type. final JsonField<String>_cik()Returns the raw JSON value of cik. final JsonField<LocalDate>_dateAfter()Returns the raw JSON value of dateAfter. final JsonField<LocalDate>_dateBefore()Returns the raw JSON value of dateBefore. final JsonField<String>_entity()Returns the raw JSON value of entity. final JsonField<List<String>>_formTypes()Returns the raw JSON value of formTypes. final JsonField<Long>_limit()Returns the raw JSON value of limit. final JsonField<Long>_offset()Returns the raw JSON value of offset. final JsonField<String>_query()Returns the raw JSON value of query. final JsonField<String>_ticker()Returns the raw JSON value of ticker. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final V1SecFilingParams.BuildertoBuilder()final V1SecFilingParams.Body_body()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static V1SecFilingParams.Builderbuilder()Returns a mutable builder for constructing an instance of V1SecFilingParams. -
-
Method Detail
-
type
final V1SecFilingParams.Type type()
Run a full-text search or fetch a single entity filing history
-
dateBefore
final Optional<LocalDate> dateBefore()
Optional upper filing date bound (YYYY-MM-DD)
-
entity
final Optional<String> entity()
Optional entity filter passed through to EDGAR full-text search
-
formTypes
final Optional<List<String>> formTypes()
Optional SEC form type filter such as 10-K, 10-Q, 8-K, or 4
-
ticker
final Optional<String> ticker()
Optional company ticker. Valid for both search and entity lookups.
-
_type
final JsonField<V1SecFilingParams.Type> _type()
Returns the raw JSON value of type.
Unlike type, this method doesn't throw if the JSON field has an unexpected type.
-
_cik
final JsonField<String> _cik()
Returns the raw JSON value of cik.
Unlike cik, this method doesn't throw if the JSON field has an unexpected type.
-
_dateAfter
final JsonField<LocalDate> _dateAfter()
Returns the raw JSON value of dateAfter.
Unlike dateAfter, this method doesn't throw if the JSON field has an unexpected type.
-
_dateBefore
final JsonField<LocalDate> _dateBefore()
Returns the raw JSON value of dateBefore.
Unlike dateBefore, this method doesn't throw if the JSON field has an unexpected type.
-
_entity
final JsonField<String> _entity()
Returns the raw JSON value of entity.
Unlike entity, this method doesn't throw if the JSON field has an unexpected type.
-
_formTypes
final JsonField<List<String>> _formTypes()
Returns the raw JSON value of formTypes.
Unlike formTypes, this method doesn't throw if the JSON field has an unexpected type.
-
_limit
final JsonField<Long> _limit()
Returns the raw JSON value of limit.
Unlike limit, this method doesn't throw if the JSON field has an unexpected type.
-
_offset
final JsonField<Long> _offset()
Returns the raw JSON value of offset.
Unlike offset, this method doesn't throw if the JSON field has an unexpected type.
-
_query
final JsonField<String> _query()
Returns the raw JSON value of query.
Unlike query, this method doesn't throw if the JSON field has an unexpected type.
-
_ticker
final JsonField<String> _ticker()
Returns the raw JSON value of ticker.
Unlike ticker, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final V1SecFilingParams.Builder toBuilder()
-
_body
final V1SecFilingParams.Body _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static V1SecFilingParams.Builder builder()
Returns a mutable builder for constructing an instance of V1SecFilingParams.
The following fields are required:
.type()
-
-
-
-