Class: Crawlora::SecEdgarGroup

Inherits:

Object

• Object
• Crawlora::SecEdgarGroup

Defined in:

sig/crawlora.rbs

Instance Method Summary

• #initialize ⇒ SecEdgarGroup constructor

  A new instance of SecEdgarGroup.

• #sec_company_intelligence ⇒ Object
• #sec_company_search ⇒ Object
• #sec_company_submissions ⇒ Object
• #sec_filing ⇒ Object
• #sec_filing_sections ⇒ Object
• #sec_financials ⇒ Object
• #sec_frames ⇒ Object
• #sec_full_text_search ⇒ Object
• #sec_insider ⇒ Object
• #sec_institutional_holdings ⇒ Object

Constructor Details

#initialize ⇒ SecEdgarGroup

Returns a new instance of SecEdgarGroup.

Parameters:

• (Client)
• (Hash[String, String])

# File 'sig/crawlora.rbs', line 828

def initialize: (Client, Hash[String, String]) -> void

Instance Method Details

#sec_company_intelligence ⇒ Object

Parameters:

• cik: (String)
• ticker: (String)
• enrich: ("market", "news", "hiring")
• ats: ("greenhouse", "lever", "ashby", "workday", "smartrecruiters")
• careers_slug: (String)
• tenant: (String)
• datacenter: (String)
• site: (String)
• _response_type: ("auto", "json", "text", "stream")
• _timeout: (Float)
• _headers: (Hash[String, String])
• (Object)

Returns:

• (Object)

# File 'sig/crawlora.rbs', line 829

def sec_company_intelligence: (?cik: String, ?ticker: String, ?enrich: "market" | "news" | "hiring", ?ats: "greenhouse" | "lever" | "ashby" | "workday" | "smartrecruiters", ?careers_slug: String, ?tenant: String, ?datacenter: String, ?site: String, ?_response_type: ("auto" | "json" | "text" | "stream"), ?_timeout: Float, ?_headers: Hash[String, String], **untyped) -> untyped

#sec_company_search ⇒ Object

Parameters:

• q: (String)
• limit: (Integer)
• _response_type: ("auto", "json", "text", "stream")
• _timeout: (Float)
• _headers: (Hash[String, String])
• (Object)

Returns:

• (Object)

# File 'sig/crawlora.rbs', line 830

def sec_company_search: (?q: String, ?limit: Integer, ?_response_type: ("auto" | "json" | "text" | "stream"), ?_timeout: Float, ?_headers: Hash[String, String], **untyped) -> untyped

#sec_company_submissions ⇒ Object

Parameters:

• cik: (String)
• ticker: (String)
• form: (String)
• from: (String)
• to: (String)
• limit: (Integer)
• _response_type: ("auto", "json", "text", "stream")
• _timeout: (Float)
• _headers: (Hash[String, String])
• (Object)

Returns:

• (Object)

# File 'sig/crawlora.rbs', line 831

def sec_company_submissions: (?cik: String, ?ticker: String, ?form: String, ?from: String, ?to: String, ?limit: Integer, ?_response_type: ("auto" | "json" | "text" | "stream"), ?_timeout: Float, ?_headers: Hash[String, String], **untyped) -> untyped

#sec_filing ⇒ Object

Parameters:

• cik: (String)
• ticker: (String)
• accession: (String)
• _response_type: ("auto", "json", "text", "stream")
• _timeout: (Float)
• _headers: (Hash[String, String])
• (Object)

Returns:

• (Object)

# File 'sig/crawlora.rbs', line 832

def sec_filing: (?cik: String, ?ticker: String, ?accession: String, ?_response_type: ("auto" | "json" | "text" | "stream"), ?_timeout: Float, ?_headers: Hash[String, String], **untyped) -> untyped

#sec_filing_sections ⇒ Object

Parameters:

• cik: (String)
• ticker: (String)
• accession: (String)
• items: (String)
• max_chars: (Integer)
• _response_type: ("auto", "json", "text", "stream")
• _timeout: (Float)
• _headers: (Hash[String, String])
• (Object)

Returns:

• (Object)

# File 'sig/crawlora.rbs', line 833

def sec_filing_sections: (?cik: String, ?ticker: String, ?accession: String, ?items: String, ?max_chars: Integer, ?_response_type: ("auto" | "json" | "text" | "stream"), ?_timeout: Float, ?_headers: Hash[String, String], **untyped) -> untyped

#sec_financials ⇒ Object

Parameters:

• cik: (String)
• ticker: (String)
• statement: ("income", "balance", "cash_flow")
• period: ("annual", "quarterly")
• limit: (Integer)
• _response_type: ("auto", "json", "text", "stream")
• _timeout: (Float)
• _headers: (Hash[String, String])
• (Object)

Returns:

• (Object)

# File 'sig/crawlora.rbs', line 834

def sec_financials: (?cik: String, ?ticker: String, ?statement: "income" | "balance" | "cash_flow", ?period: "annual" | "quarterly", ?limit: Integer, ?_response_type: ("auto" | "json" | "text" | "stream"), ?_timeout: Float, ?_headers: Hash[String, String], **untyped) -> untyped

#sec_frames ⇒ Object

Parameters:

• concept: (String)
• period: (String)
• unit: (String)
• taxonomy: ("dei", "ifrs-full", "srt", "us-gaap")
• limit: (Integer)
• _response_type: ("auto", "json", "text", "stream")
• _timeout: (Float)
• _headers: (Hash[String, String])
• (Object)

Returns:

• (Object)

# File 'sig/crawlora.rbs', line 835

def sec_frames: (?concept: String, ?period: String, ?unit: String, ?taxonomy: "dei" | "ifrs-full" | "srt" | "us-gaap", ?limit: Integer, ?_response_type: ("auto" | "json" | "text" | "stream"), ?_timeout: Float, ?_headers: Hash[String, String], **untyped) -> untyped

#sec_full_text_search ⇒ Object

Parameters:

• q: (String)
• forms: (String)
• from: (String)
• to: (String)
• page: (Integer)
• _response_type: ("auto", "json", "text", "stream")
• _timeout: (Float)
• _headers: (Hash[String, String])
• (Object)

Returns:

• (Object)

# File 'sig/crawlora.rbs', line 836

def sec_full_text_search: (?q: String, ?forms: String, ?from: String, ?to: String, ?page: Integer, ?_response_type: ("auto" | "json" | "text" | "stream"), ?_timeout: Float, ?_headers: Hash[String, String], **untyped) -> untyped

#sec_insider ⇒ Object

Parameters:

• cik: (String)
• ticker: (String)
• limit: (Integer)
• _response_type: ("auto", "json", "text", "stream")
• _timeout: (Float)
• _headers: (Hash[String, String])
• (Object)

Returns:

• (Object)

# File 'sig/crawlora.rbs', line 837

def sec_insider: (?cik: String, ?ticker: String, ?limit: Integer, ?_response_type: ("auto" | "json" | "text" | "stream"), ?_timeout: Float, ?_headers: Hash[String, String], **untyped) -> untyped

#sec_institutional_holdings ⇒ Object

Parameters:

• cik: (String)
• limit: (Integer)
• _response_type: ("auto", "json", "text", "stream")
• _timeout: (Float)
• _headers: (Hash[String, String])
• (Object)

Returns:

• (Object)

# File 'sig/crawlora.rbs', line 838

def sec_institutional_holdings: (?cik: String, ?limit: Integer, ?_response_type: ("auto" | "json" | "text" | "stream"), ?_timeout: Float, ?_headers: Hash[String, String], **untyped) -> untyped