Skip to main content

APIEndpoint

Enum APIEndpoint 

Source
pub enum APIEndpoint {
Show 31 variants BalanceDistribution, IndicesOHLCV, SpotOHLCV, SpotInstrumentMetadata, SpotMarketsV2, SpotMarketsInstruments, FuturesOHLCV, FuturesInstrumentMetadata, FuturesMarketsV2, OptionsOHLCV, OptionsInstrumentMetadata, OptionsMarketsV2, DerIndicesOHLCV, DerIndicesMarketsV2, OCDEXOHLCV, OCDEXMarketsV2, OCCoreETHBlocks, OCCoreAssetsByChain, OCCoreAssetByAddress, OCCoreSupply, AssetMetadataV2, AssetEvents, AssetCodeRepo, AssetDiscord, AssetReddit, AssetTelegram, AssetTwitter, NewsLatestArticles, NewsSources, NewsCategories, OverviewMktCapOHLCV,
}
Expand description

All supported API endpoints.

Variants§

§

BalanceDistribution

👎Deprecated since 1.0.6:

Deprecated by CoinDesk

Description: Retrieves the balance distribution for a specified asset over a specified time range at a daily interval

Note: This is a legacy API endpoint and is not actively supported. Only data for BTC (Bitcoin) is available.

URL: https://min-api.cryptocompare.com/data/blockchain/balancedistribution/histo/day

§

IndicesOHLCV

Description: Provides historical candlestick data for various indices

URL: https://data-api.coindesk.com/index/cc/v1/historical

§

SpotOHLCV

Description: Provides candlestick data for specific cryptocurrency instruments across selected exchanges

URL: https://data-api.coindesk.com/spot/v1/historical

§

SpotInstrumentMetadata

Description: Delivers vital metadata about financial instruments traded on specified exchanges, focusing solely on non-price related information

URL: https://data-api.coindesk.com/spot/v1/latest/instrument/metadata

§

SpotMarketsV2

Description: Provides comprehensive information about various cryptocurrency spot markets, featuring extensive exchange metadata and operational details.

URL: https://data-api.coindesk.com/spot/v2/markets

§

SpotMarketsInstruments

Description: Retrieves a comprehensive dictionary of mapped instruments across one or more spot markets, filtered by a specified state or status

URL: https://data-api.coindesk.com/spot/v1/markets/instruments

§

FuturesOHLCV

Description: Provides aggregated candlestick data for specific futures instruments on designated exchanges

URL: https://data-api.coindesk.com/futures/v1/historical

§

FuturesInstrumentMetadata

Description: Provides essential metadata about futures instruments traded on various exchanges.

URL: https://data-api.coindesk.com/futures/v1/latest/instrument/metadata

§

FuturesMarketsV2

Description: Provides comprehensive information about various cryptocurrency futures markets, featuring extensive exchange metadata and derivatives-specific operational details.

URL: https://data-api.coindesk.com/futures/v2/markets

§

OptionsOHLCV

Description: Provides historical OHLCV (open, high, low, close, volume) data for specified options instruments on a chosen exchange

URL: https://data-api.coindesk.com/options/v1/historical

§

OptionsInstrumentMetadata

Description: Provides detailed metadata about options instruments across various exchanges.

URL: https://data-api.coindesk.com/options/v1/latest/instrument/metadata

§

OptionsMarketsV2

Description: Provides comprehensive information about various cryptocurrency options markets, featuring extensive exchange metadata and derivatives-specific operational details.

URL: https://data-api.coindesk.com/options/v2/markets

§

DerIndicesOHLCV

Description: Provides historical OHLC (open, high, low, close) data for specified index instruments on a selected market

URL: https://data-api.coindesk.com/index/v1/historical

§

DerIndicesMarketsV2

Description: Provides comprehensive information about various derivatives index markets, featuring extensive exchange metadata and index-specific operational details.

URL: https://data-api.coindesk.com/index/v2/markets

§

OCDEXOHLCV

Description: Retrieves aggregated candlestick data for AMM swap transactions

URL: https://data-api.coindesk.com/onchain/v1/amm/historical/swap

§

OCDEXMarketsV2

Description: Provides comprehensive information about various on-chain decentralized exchange markets, featuring extensive exchange metadata and DEX-specific operational details.

URL: https://data-api.coindesk.com/onchain/v2/amm/markets

§

OCCoreETHBlocks

Description: Delivers exhaustive details on a specific Ethereum block in a meticulously processed format, complete with detailed explanations for each field

URL: https://data-api.coindesk.com/onchain/v1/block/2

§

OCCoreAssetsByChain

Description: Retrieves a comprehensive summary of chain asset information for a specified blockchain, identified by its chain symbol

URL: https://data-api.coindesk.com/onchain/v3/summary/by/chain

§

OCCoreAssetByAddress

Description: Retrieves comprehensive asset information for a specific asset identified by its smart contract address and associated blockchain asset

URL: https://data-api.coindesk.com/onchain/v2/data/by/address

§

OCCoreSupply

Description: Retrieves comprehensive historical supply data for various digital assets identified by either their CoinDesk asset ID or unique asset symbol

URL: https://data-api.coindesk.com/onchain/v2/historical/supply/days

§

AssetMetadataV2

Descriptions: Returns an object that provides detailed and comprehensive information about multiple cryptocurrency assets in response to a request

URL: https://data-api.coindesk.com/asset/v2/metadata

§

AssetEvents

Description: Retrieves an array of significant events related to digital assets, such as security incidents, rebrandings, blockchain forks, and other impactful developments

URL: https://data-api.coindesk.com/asset/v1/events

§

AssetCodeRepo

Description: Provides an in-depth, daily snapshot of a digital asset’s code repositories

URL: https://data-api.coindesk.com/asset/v1/historical/code-repository/days

§

AssetDiscord

Description: Aggregates detailed daily metrics from all Discord servers related to a specific digital asset, offering a multifaceted view into community engagement and the asset’s standing within Discord communities

URL: https://data-api.coindesk.com/asset/v1/historical/discord/days

§

AssetReddit

Description: Aggregates key performance indicators from all the subreddits related to a specific digital asset, providing a comprehensive understanding of the asset’s footprint on Reddit

URL: https://data-api.coindesk.com/asset/v1/historical/reddit/days

§

AssetTelegram

Description: Collates essential data points across all Telegram groups affiliated with a particular cryptocurrency asset

URL: https://data-api.coindesk.com/asset/v1/historical/telegram/days

§

AssetTwitter

Description: Aggregates essential metrics from all X (Twitter) accounts associated with a specific cryptocurrency asset

URL: https://data-api.coindesk.com/asset/v1/historical/twitter/days

§

NewsLatestArticles

Description: Serves as the pulse of the crypto news landscape, providing users with instant access to the most recent articles across the industry

URL: https://data-api.coindesk.com/news/v1/article/list

§

NewsSources

Description: Offers a comprehensive listing of all news sources available through CoinDesk API

URL: https://data-api.coindesk.com/news/v1/source/list

§

NewsCategories

Description: Provide a straightforward listing of all news categories available through CoinDesk API

URL: https://data-api.coindesk.com/news/v1/category/list

§

OverviewMktCapOHLCV

Description: Presents a thorough historical daily overview of market capitalisation for digital assets that meet the volume and listing criteria

URL: https://data-api.coindesk.com/overview/v1/historical/marketcap/all/assets/days

Trait Implementations§

Source§

impl APIEndpointTrait for APIEndpoint

Source§

fn default_groups(&self) -> Option<Vec<Group>>

Returns a vector of default groups to apply to match the pre-defined schemas. Read more
Source§

fn default_params(&self) -> Option<Vec<Param<'_>>>

Returns a vector of default API endpoint parameters to apply to match the pre-defined schemas. Read more
Source§

fn url(&self, unit: &Unit) -> String

Produces URL for a given API endpoint. Read more
Source§

impl Clone for APIEndpoint

Source§

fn clone(&self) -> APIEndpoint

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for APIEndpoint

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for APIEndpoint

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for APIEndpoint

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for APIEndpoint

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,