Struct CIKQuery 

pub struct CIKQuery { /* private fields */ }

Provides a methods to get short CIKs (no leading zeros) from a ticker represented as string.

Implementations

impl CIKQuery

pub fn new(file_path: Option<&str>) -> Result<CIKQuery, EDGARError>

Instantiates CIKQuery with an optionally defined file_path. If the file path does not exist or the file_path is None, then the default URL is used.

use sec_edgar::edgar_query::cik_query::CIKQuery;
let ticker = Some("amd");
let cik_query = CIKQuery::new(ticker);

pub async fn get_cik(&self, ticker: &str) -> Result<String, EDGARError>

Returns the short CIK (no leading zeros) either from the default URL or from the file defined when CIKQuery was instantiated.

use sec_edgar::edgar_query::cik_query::CIKQuery;
async fn some_func() {
    let ticker = "AMD";
    let cik_query = CIKQuery::new(None).unwrap();
    // To save yourself a trip, you can define the path to a local file, which should be the same as what is found [here](https://www.sec.gov/include/ticker.txt).
    // let cik_query = CIKQuery::new(Some("./your/local/file")).await;
    let cik = cik_query.get_cik(ticker).await;
}

The ticker is case-insensitive.

Trait Implementations

impl Debug for CIKQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CIKQuery

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CIKQuery