coinpaprika_api/lib.rs
1//! # Coinpaprika API
2//!
3//! Coinpaprika API Rust library provides access to [Coinpaprika API](https://api.coinpaprika.com/)
4//! for applications written in Rust programming language.
5//!
6//! [Coinpaprika API](https://api.coinpaprika.com/) delivers precise & frequently updated market
7//! data from the world of crypto: coin prices, volumes, market caps, ATHs, return rates and more.
8//!
9//!
10//! ## Usage
11//!
12//! Put this in your Cargo.toml:
13//!
14//! ```toml
15//! [dependencies]
16//! coinpaprika_api = "0.1"
17//! ```
18//!
19//! Then you can use it like this:
20//!
21//! ```rust
22//! use coinpaprika_api::client::Client;
23//! use coinpaprika_api::global::Global;
24//! use std::error::Error;
25//!
26//! #[tokio::main]
27//! async fn main() -> Result<(), Box<dyn Error>> {
28//! let client = Client::new();
29//!
30//! let global: Global = client.global().send().await?;
31//! println!("global: {:#?}", global);
32//!
33//! Ok(())
34//! }
35//! ```
36//!
37//! We include examples for each section of the API, located in `/examples` folder.
38//!
39//!
40//! ## Supported Endpoints
41//!
42//! - Key
43//! - [x] Get API key info
44//!
45//! - Global
46//! - [x] Get market overview data
47//!
48//! - Coins
49//! - [x] List coins
50//! - [x] Get coin by ID
51//! - [x] Get Twitter timeline tweets for a coin
52//! - [x] Get coin events by coin ID
53//! - [x] Get exchanges by coin ID
54//! - [x] Get markets by coin ID
55//! - [x] Get OHLC for the last full day
56//! - [x] Get historical OHLC
57//! - [x] Get today OHLC
58//!
59//! - People
60//! - [x] Get person by ID
61//!
62//! - Tags
63//! - [x] List tags
64//! - [x] Get tag by ID
65//!
66//! - Tickers
67//! - [x] Get tickers for all active coins
68//! - [x] Get ticker for a specific coin
69//! - [x] Get historical ticks for a specific coin
70//!
71//! - Exchanges
72//! - [x] List exchanges
73//! - [x] Get exchange by ID
74//! - [x] List an exchange markets
75//!
76//! - Tools
77//! - [x] Search
78//! - [x] Price converter
79//!
80//! - Contracts
81//! - [x] List contracts platforms
82//! - [x] Get all contract addressess for a given platform
83//! - [ ] Redirect to Ticker by contract address
84//! - [ ] Redirect to historical ticks by contract address
85//!
86//! - Changelog
87//! - [x] Get id changelog for all coins
88//!
89//! - Beta
90//! - [ ] List sentiment coins
91//! - [ ] Get sentiment data for a specific coin
92//! - [ ] Get historical sentiment data for a specific coin
93//!
94//!
95//! ## License
96//!
97//! CoinpaprikaAPI Rust client is available under the MIT license. See the [LICENSE file](./LICENSE) for more info.
98//!
99
100/// Client struct used for connecting with coinpaprika.com
101pub mod client;
102
103/// Possible errors Client can return
104pub mod error;
105
106//
107// API Sections
108//
109
110/// Requests for "Key" section of the API
111pub mod key;
112
113/// Requests for "Global" section of the API
114pub mod global;
115
116/// Requests for "Coins" section of the API
117pub mod coins;
118
119/// Requests for "People" section of the API
120pub mod people;
121
122/// Requests for "Tags" section of the API
123pub mod tags;
124
125/// Requests for "Tickers" section of the API
126pub mod tickers;
127
128/// Requests for "Exchanges" section of the API
129pub mod exchanges;
130
131/// Requests for "Tools" section of the API
132pub mod tools;
133
134/// Requests for "Contracts" section of the API
135pub mod contracts;
136
137/// Requests for "Changelog" section of the API
138pub mod changelog;