openfigi-rs 0.3.0

A Rust client for interacting with the OpenFIGI API and parsing financial data.
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
41
42
43
44
45
46

//! 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
//!
//! ## [`FilterData`]
//! 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.
//!
//! ## [`MappingData`]
//! Response from the `/v3/mapping` endpoint for single request converting third-party identifiers
//! (tickers, ISINs, CUSIPs) into FIGI identifiers. Returns an array of results
//! corresponding to each mapping request in the batch.
//!
//! ## [`MappingResponses`]
//! Ergonomic batch response wrapper for the `/v3/mapping` endpoint. Provides indexed access
//! to successes and errors, preserving the order of requests and allowing users to determine
//! which mapping requests succeeded or failed.
//!
//! ## [`SearchData`]
//! 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
//! - Support serialization/deserialization with serde
//! - Provide pagination support where applicable

mod common;
pub(crate) use self::common::ResponseResult;

mod mapping_response;
pub use self::mapping_response::MappingData;
pub use self::mapping_response::MappingResponses;

mod search_response;
pub use self::search_response::SearchData;

mod filter_response;
pub use self::filter_response::FilterData;