CUSIP is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the `cusip-tool` executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install cusip

It will make the cusip-tool command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall cusip uninstalls.

Adding `cusip` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add cusip

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

cusip = "0.3.3"

The cusip library will be automatically available globally. Read the cusip library documentation.

Back to the crate overview.

Readme

cusip

An CUSIP type for working with validated Committee on Uniform Security Identification Procedures (CUSIP) identifiers as defined in ANSI X9.6-2020. There is also a companion type CINS for working with the subset of CUSIP identifiers that conform to the CINS standard.

This crate is part of the Financial Identifiers series:

CIK: Central Index Key (SEC EDGAR)
CUSIP: Committee on Uniform Security Identification Procedures (ANSI X9.6-2020)
ISIN: International Securities Identification Number (ISO 6166:2021)
LEI: Legal Entity Identifier (ISO 17442:2020)

Usage

Add this to your Cargo.toml:

[dependencies]
cusip = "0.3.1"

Example

use cusip;
let cusip_string = "023135106"; // Amazon.com Inc - Common Stock
match cusip::parse(cusip_string) {
    Ok(cusip) => {
        println!("Parsed CUSIP: {}", cusip.to_string()); // "023135106"
        println!("  Issuer number: {}", cusip.issuer_num()); // "023135"
        println!("  Issue number: {}", cusip.issue_num()); // "10"
        println!("  Check digit: {}", cusip.check_digit()); // '6'
    }
    Err(err) => panic!("Unable to parse CUSIP {}: {}", cusip_string, err),
}

License

Licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Installing the cusip-tool executable

Adding cusip library as a dependency

Installing the `cusip-tool` executable

Adding `cusip` library as a dependency