openfigi-rs 0.1.0

A Rust client for interacting with the OpenFIGI API and parsing financial data.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

//! Response data structures for OpenFIGI API endpoints.
//!
//! This module contains all the response types returned by the OpenFIGI API endpoints.
//! Each endpoint has its own dedicated response module with specialized data structures
//! that handle the specific format and semantics of that endpoint's responses.
//!
//! # Available Response Types
//!
//! ## [`FilterResponse`]
//! Response from the `/v3/filter` endpoint for structured filtering of financial
//! instruments using specific criteria. Returns FIGI results with optional pagination
//! and total count information.
//!
//! ## [`MappingResponse`]
//! Response from the `/v3/mapping` endpoint for converting third-party identifiers
//! (tickers, ISINs, CUSIPs) into FIGI identifiers. Returns an array of results
//! corresponding to each mapping request in the batch.
//!
//! ## [`SearchResponse`]
//! Response from the `/v3/search` endpoint for text-based searches of financial
//! instruments. Returns FIGI results ordered by relevance with optional pagination.
//!
//! # Common Patterns
//!
//! All response types follow consistent patterns:
//! - Use the `ResponseResult` enum to handle success/error cases
//! - Implement the `FigiData` trait for uniform data access
//! - Support serialization/deserialization with serde
//! - Provide pagination support where applicable

mod common;

mod mapping_response;
pub use self::mapping_response::MappingResponse;

mod search_response;
pub use self::search_response::SearchResponse;

mod filter_response;
pub use self::filter_response::FilterResponse;