Package Health Score

55 / 100

security
Security review needed
popularity
Popular
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Popularity

Popular

GitHub Stars: 1.05K
Forks: 273
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package pycoingecko, we found that it has been starred 1,046 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Oct 26, 2022
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
1
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like pycoingecko is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 13
Open PR: 5
Last Release: 2 years ago
Last Commit: 2 years ago

Further analysis of the maintenance status of pycoingecko based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for pycoingecko is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the pycoingecko repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like pycoingecko is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: ==2.*, ==3.*

Age: 6 years
Latest Release: 2 years ago
Dependencies: 1 Direct / 5 Total
Versions: 17
Maintainers: 1
Wheels: OS Independent

Not sure how to use pycoingecko?

To help you get started, we've collected the most common ways that pycoingecko is being used within popular public projects.

man-c / pycoingecko / tests / test_api.py View on Github

def test_get_exchanges_id_name_list(self):
        # Arrange
        json_response = [{'id': 'abcc', 'name': 'ABCC'}, {'id': 'acx', 'name': 'ACX'}, {'id': 'airswap', 'name': 'AirSwap'}]

        responses.add(responses.GET, 'https://api.coingecko.com/api/v3/exchanges/list',
                          json = json_response, status = 200)

        # Act
        response = CoinGeckoAPI().get_exchanges_id_name_list()

        ## Assert
        assert response == json_response

View more ways to use pycoingecko

CoinGecko API wrapper

GitHub

Python3 wrapper around the CoinGecko API (V3)

Installation

PyPI

pip install -U pycoingecko

or from source

git clone https://github.com/man-c/pycoingecko.git
cd pycoingecko
python3 setup.py install

Usage

For free API:

from pycoingecko import CoinGeckoAPI
cg = CoinGeckoAPI()

For users with Pro API Key:

from pycoingecko import CoinGeckoAPI
cg = pycoingecko.CoinGeckoAPI(api_key='YOUR_API_KEY')

Examples

The required parameters for each endpoint are defined as required (mandatory) parameters for the corresponding functions.
Any optional parameters can be passed using same names, as defined in CoinGecko API doc (https://www.coingecko.com/en/api/documentation).

For any parameter:

Lists are supported as input for multiple-valued comma-separated parameters
(e.g. see /simple/price usage examples).
Booleans are supported as input for boolean type parameters; they can be str ('true', 'false'') or bool (True, False)
(e.g. see /simple/price usage examples).

Usage examples:

# /simple/price endpoint with the required parameters
&gt;&gt;&gt; cg.get_price(ids='bitcoin', vs_currencies='usd')
{'bitcoin': {'usd': 3462.04}}

&gt;&gt;&gt; cg.get_price(ids='bitcoin,litecoin,ethereum', vs_currencies='usd')
# OR (lists can be used for multiple-valued arguments)
&gt;&gt;&gt; cg.get_price(ids=['bitcoin', 'litecoin', 'ethereum'], vs_currencies='usd')
{'bitcoin': {'usd': 3461.27}, 'ethereum': {'usd': 106.92}, 'litecoin': {'usd': 32.72}}

&gt;&gt;&gt; cg.get_price(ids='bitcoin,litecoin,ethereum', vs_currencies='usd,eur')
# OR (lists can be used for multiple-valued arguments)
&gt;&gt;&gt; cg.get_price(ids=['bitcoin', 'litecoin', 'ethereum'], vs_currencies=['usd', 'eur'])
{'bitcoin': {'usd': 3459.39, 'eur': 3019.33}, 'ethereum': {'usd': 106.91, 'eur': 93.31}, 'litecoin': {'usd': 32.72, 'eur': 28.56}}

# optional parameters can be passed as defined in the API doc (https://www.coingecko.com/api/docs/v3)
&gt;&gt;&gt; cg.get_price(ids='bitcoin', vs_currencies='usd', include_market_cap='true', include_24hr_vol='true', include_24hr_change='true', include_last_updated_at='true')
{'bitcoin': {'usd': 3458.74, 'usd_market_cap': 60574330199.29028, 'usd_24h_vol': 4182664683.6247883, 'usd_24h_change': 1.2295378479069035, 'last_updated_at': 1549071865}}
# OR (also booleans can be used for boolean type arguments)
&gt;&gt;&gt; cg.get_price(ids='bitcoin', vs_currencies='usd', include_market_cap=True, include_24hr_vol=True, include_24hr_change=True, include_last_updated_at=True)
{'bitcoin': {'usd': 3458.74, 'usd_market_cap': 60574330199.29028, 'usd_24h_vol': 4182664683.6247883, 'usd_24h_change': 1.2295378479069035, 'last_updated_at': 1549071865}}

API documentation

https://www.coingecko.com/en/api/documentation

Endpoints included

> ⚠️ Endpoints documentation: To make sure that you are using properly each endpoint you should check the API documentation. Return behaviour and parameters of the endpoints, such as pagination, might have changed.
Any optional parameters defined in CoinGecko API doc can be passed as function parameters using same parameters names with the API (see Examples above).

ping

/ping (Check API server status)
```
cg.ping()
```

simple

/simple/price (Get the current price of any cryptocurrencies in any other supported currencies that you need)
```
cg.get_price()
```
/simple/token_price/{id} (Get current price of tokens (using contract addresses) for a given platform in any other currency that you need)
```
cg.get_token_price()
```
/simple/supported_vs_currencies (Get list of supported_vs_currencies)
```
cg.get_supported_vs_currencies()
```

coins

/coins/list (List all supported coins id, name and symbol (no pagination required))
```
cg.get_coins_list()
```
/coins/markets (List all supported coins price, market cap, volume, and market related data)
```
cg.get_coins_markets()
```
/coins/{id} (Get current data (name, price, market, ... including exchange tickers) for a coin)
```
cg.get_coin_by_id()
```
/coins/{id}/tickers (Get coin tickers (paginated to 100 items))
```
cg.get_coin_ticker_by_id()
```
/coins/{id}/history (Get historical data (name, price, market, stats) at a given date for a coin)
```
cg.get_coin_history_by_id()
```
/coins/{id}/market_chart (Get historical market data include price, market cap, and 24h volume (granularity auto))
```
cg.get_coin_market_chart_by_id()
```
/coins/{id}/market_chart/range (Get historical market data include price, market cap, and 24h volume within a range of timestamp (granularity auto))
```
cg.get_coin_market_chart_range_by_id()
```

//: # (* /coins/{id}/status_updates (Get status updates for a given coin (beta)))

//: # ( cg.get_coin_status_updates_by_id())

/coins/{id}/ohlc (Get coin's OHLC (beta))
```
cg.get_coin_ohlc_by_id()
```

contract

/coins/{id}/contract/{contract_address} (Get coin info from contract address)
```
cg.get_coin_info_from_contract_address_by_id()
```
/coins/{id}/contract/{contract_address}/market_chart/ (Get historical market data include price, market cap, and 24h volume (granularity auto) from a contract address)
```
cg.get_coin_market_chart_from_contract_address_by_id()
```
/coins/{id}/contract/{contract_address}/market_chart/range (Get historical market data include price, market cap, and 24h volume within a range of timestamp (granularity auto) from a contract address)
```
cg.get_coin_market_chart_range_from_contract_address_by_id()
```

asset_platforms

/asset_platforms (List all asset platforms (Blockchain networks))
```
cg.get_asset_platforms()
```

categories

/coins/categories/list (List all categories)
```
cg.get_coins_categories_list()
```
coins/categories (List all categories with market data)
```
cg.get_coins_categories()
```

exchanges

/exchanges (List all exchanges)
```
cg.get_exchanges_list()
```
/exchanges/list (List all supported markets id and name (no pagination required))
```
cg.get_exchanges_id_name_list()
```
/exchanges/{id} (Get exchange volume in BTC and top 100 tickers only)
```
cg.get_exchanges_by_id()
```
/exchanges/{id}/tickers (Get exchange tickers (paginated, 100 tickers per page))
```
cg.get_exchanges_tickers_by_id()
```

//: # (* /exchanges/{id}/status_updates (Get status updates for a given exchange (beta)))

//: # ( cg.get_exchanges_status_updates_by_id())

/exchanges/{id}/volume_chart (Get volume_chart data for a given exchange)
```
cg.get_exchanges_volume_chart_by_id()
```

//: # (* /finance_platforms (List all finance platforms))

//: # ( cg.get_finance_platforms())

//: # (* /finance_products (List all finance products))

//: # ( cg.get_finance_products())

indexes

/indexes (List all market indexes)

cg.get_indexes()

/indexes/{market_id}/{id} (Get market index by market id and index id)

cg.get_indexes_by_market_id_and_index_id()

/indexes/list (List market indexes id and name)

cg.get_indexes_list()

derivatives

/derivatives (List all derivative tickers)
```
cg.get_derivatives()
```
/derivatives/exchanges (List all derivative exchanges)
```
cg.get_derivatives_exchanges()
```
/derivatives/exchanges/{id} (Show derivative exchange data)
```
cg.get_derivatives_exchanges_by_id()
```
/derivatives/exchanges/list (List all derivative exchanges name and identifier)
```
cg.get_derivatives_exchanges_list()
```

nfts (beta)

/nfts/list (List all supported NFT ids, paginated by 100 items per page, paginated to 100 items)
```
cg.get_nfts_list()
```
/nfts/{id} (Get current data (name, price_floor, volume_24h ...) for an NFT collection. native_currency (string) is only a representative of the currency.)
```
cg.get_nfts_by_id()
```
/nfts/{asset_platform_id}/contract/{contract_address} (Get current data (name, price_floor, volume_24h ...) for an NFT collection. native_currency (string) is only a representative of the currency)
```
cg.get_nfts_collection_by_asset_platform_id_and_contract_address()
```

//: # (* /status_updates (List all status_updates with data (description, category, created_at, user, user_title and pin)))

//: # ( cg.get_status_updates())

//: # (* /events (Get events, paginated by 100))

//: # ( cg.get_events())

//: # (* /events/countries (Get list of event countries))

//: # ( cg.get_events_countries())

//: # (* /events/types (Get list of events types))

//: # ( cg.get_events_types())

exchange_rates

/exchange_rates (Get BTC-to-Currency exchange rates)
```
cg.get_exchange_rates()
```

/search (Search for coins, categories and markets on CoinGecko)
```
cg.search()
```

trending

/search/trending (Get trending search coins (Top-7) on CoinGecko in the last 24 hours)
```
cg.get_search_trending()
```

global

/global (Get cryptocurrency global data)
```
cg.get_global()
```
/global/decentralized_finance_defi (Get cryptocurrency global decentralized finance(defi) data)
```
cg.get_global_decentralized_finance_defi()
```

companies (beta)

/companies/public_treasury/{coin_id} (Get public companies data)
```
cg.get_companies_public_treasury_by_coin_id()
```

Test

Installation

Install required packages for testing using:

pip install pytest responses

Usage

Run unit tests with:

# after installing pytest and responses using pip3
pytest tests

License

MIT

pycoingecko dependencies

requests

FAQs

What is pycoingecko?

Python wrapper around the CoinGecko API. Visit Snyk Advisor to see a full health score report for pycoingecko, including popularity, security, maintenance & community analysis.

Is pycoingecko popular?

The python package pycoingecko receives a total of 69,586 weekly downloads. As such, pycoingecko popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is pycoingecko well maintained?

We found indications that pycoingecko is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is pycoingecko safe to use?

While scanning the latest version of pycoingecko, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 9 November-2024, at 02:19 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

pycoingecko

Python wrapper around the CoinGecko API For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Not sure how to use pycoingecko?

CoinGecko API wrapper

Installation

Usage

Examples

API documentation

Endpoints included

Test

Installation

Usage

License

pycoingecko dependencies

FAQs

What is pycoingecko?

Is pycoingecko popular?

Is pycoingecko well maintained?

Is pycoingecko safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Not sure how to use pycoingecko?

CoinGecko API wrapper

Installation

Usage

Examples

API documentation

Endpoints included

Test

Installation

Usage

License

pycoingecko dependencies

FAQs

What is pycoingecko?

Is pycoingecko popular?

Is pycoingecko well maintained?

Is pycoingecko safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues