coinpaprika-api-php-client

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #android #rust #deep-learning #docker #macos #awesome #cli #vue #openai #open-source

coinpaprika-api-php-client

(★ 24)

Official CoinPaprika API PHP client — coin prices, exchanges, OHLCV, and global market stats.

coinpaprika-api-php-client 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Coinpaprika API PHP Client
[![Coins](https://img.shields.io/badge/dynamic/json.svg?url=https://api.coinpaprika.com/v1/global&label=coins&query=$.cryptocurrencies_number&colorB=lightgrey&maxAge=3600)](https://coinpaprika.com)
[![Bitcoin Price USD](https://img.shields.io/badge/dynamic/json.svg?url=https://api.coinpaprika.com/v1/tickers/btc-bitcoin&label=Bitcoin&query=$.quotes.USD.price&colorB=brightgreen&prefix=$%20&maxAge=3600)](https://coinpaprika.com)

[![Logo](https://coinpaprika.com/static/files/d6d3c6e3.svg#greywizard/rock-coin-web/assets/coin/img/cp-logo-beta.svg)](https://api.coinpaprika.com/)

[![Latest Stable Version](https://poser.pugx.org/coinpaprika/coinpaprika-api-php-client/v/stable)](https://packagist.org/packages/coinpaprika/coinpaprika-api-php-client)
[![Build Status](https://scrutinizer-ci.com/g/coinpaprika/coinpaprika-api-php-client/badges/build.png?b=master)](https://scrutinizer-ci.com/g/coinpaprika/coinpaprika-api-php-client/build-status/master)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://raw.githubusercontent.com/coinpaprika/coinpaprika-api-php-client/master/LICENSE.md)
[![Quality Score](https://img.shields.io/scrutinizer/g/coinpaprika/coinpaprika-api-php-client.svg?style=flat-square)](https://scrutinizer-ci.com/g/coinpaprika/coinpaprika-api-php-client)
[![Code Coverage](https://scrutinizer-ci.com/g/coinpaprika/coinpaprika-api-php-client/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/coinpaprika/coinpaprika-api-php-client/?branch=master)
[![Total Downloads](https://poser.pugx.org/coinpaprika/coinpaprika-api-php-client/downloads)](https://packagist.org/packages/coinpaprika/coinpaprika-api-php-client)

## Usage

This library provides convenient way to use [coinpaprika.com API](https://api.coinpaprika.com/) in PHP.

[Coinpaprika](https://coinpaprika.com) delivers full market data to the world of crypto: coin prices, volumes, market caps, ATHs, return rates and more.

## Requirements

* PHP >= 8.0
* (optional) PHPUnit to run tests.

## Install

Via Composer:

```bash
$ composer require coinpaprika/coinpaprika-api-php-client
```

## Getting started

```php
<?php

// This file is generated by Composer
require_once __DIR__ . '/vendor/autoload.php';

$client = new \Coinpaprika\Client();
$coins = $client->getCoins();
```
From `$client` object, you can access all the endpoints.

## Cache usage
For deserialization process it is advised to initiate the `$client` with `$cacheDir` argument.
 ```php
 <?php
 
 // This file is generated by Composer
 require_once __DIR__ . '/vendor/autoload.php';
 
 $client = new \Coinpaprika\Client(cacheDir: 'my/cache/directory');
 $coins = $client->getTickers();
 ```

## Paid API
Pass the API key as the first constructor argument (or use `setApiKey()` after construction). The client will automatically route requests to `api-pro.coinpaprika.com`.
 ```php
 <?php

// This file is generated by Composer
 require_once __DIR__ . '/vendor/autoload.php';

$client = new \Coinpaprika\Client('PROVIDED_API_KEY');
 $coins = $client->getCoins();
 ```

## API Coverage

```php
$client = new \Coinpaprika\Client();
```

### Market Data
```php
$client->getGlobalStats();                    // Global market overview
$client->getCoins();                          // List all coins
$client->getTokenMeta('btc-bitcoin');         // Coin details
$client->getTickers();                        // All tickers
$client->getTickerByCoinId('btc-bitcoin');    // Ticker for coin
$client->getHistoricalTickerByCoinId('btc-bitcoin', '2024-01-01', '24h'); // Historical
```

### OHLCV
```php
$client->getOHLCV('btc-bitcoin', '24h');                         // Latest OHLCV
$client->getTodayOHLCV('btc-bitcoin');                           // Today's OHLCV
$client->getHistoricalOHLCV('btc-bitcoin', '2024-01-01');        // Historical OHLCV
```

### Exchanges
```php
$client->getExchanges();                             // ExchangeDetail[]
$client->getExchangeById('binance');                 // ExchangeDetail
$client->getExchangeMarkets('binance');              // array (raw)
```

### Coins
```php
$client->getCoinTwitter('btc-bitcoin');              // array (raw)
$client->getCoinEvents('btc-bitcoin');               // array (raw)
$client->getCoinExchanges('btc-bitcoin');            // array (raw)
$client->getCoinMarkets('btc-bitcoin');              // Market[]
$client->getCoinsMappings();                         // array (raw, Pro)
```

### Contracts
```php
$client->getPlatforms();                                          // List platforms
$client->getContracts('eth-ethereum');                            // Contracts on Ethereum
$client->getTickerByContract('eth-ethereum', '0xdac1...');        // Ticker by contract
$client->getHistoricalByContract('eth-ethereum', '0xdac1...', ['start' => '2024-01-01']);
```

### Other
```php
$client->search('bitcoin');                          // Search
$client->priceConverter(['base_currency_id' => 'btc-bitcoin', 'quote_currency_id' => 'usd-us-dollars', 'amount' => 1]);
$client->getPersonById('vitalik-buterin');            // array (raw)
$client->getTags();                                   // array (raw)
$client->getTagById('blockchain-service');             // array (raw)
$client->getKeyInfo();                                // KeyInfo (requires API key)
$client->getCoinsMappings();                          // CoinMapping[] (Business+)
$client->getChangelogIds();                           // ChangelogEntry[] (paid plans)
$client->getIcos();                                   // Ico[]
```

## Return types

Endpoints come in two flavors:

- **Typed**: returned as JMS-deserialized model classes under `Coinpaprika\Model\*`. Covers the bulk of the surface: `GlobalStats`, `Ticker`, `HistoricalTicker`, `Coin`, `CoinMeta`, `OHLCV`, `Ico`, `Search`, `Market`, `ExchangeDetail`, `KeyInfo`, `CoinMapping`, `ChangelogEntry`.
- **Raw `array`**: auxiliary endpoints whose shape is easier to work with as a plain decoded-JSON blob (Twitter timelines, events, tags, contracts, price converter, etc.). The [Coinpaprika API reference](https://docs.coinpaprika.com/) is the source of truth for those shapes.

## Examples

Check out the [`./examples`](./examples) directory. For a quick end-to-end sanity run against the live API:

```bash
php examples/smokeTest.php                 # free API
API_KEY=xxx php examples/smokeTest.php     # Pro API
```

Load/latency profiling:

```bash
STRESS_ITERATIONS=100 php examples/stressTest.php              # ~10s at default 100ms delay
STRESS_ITERATIONS=500 STRESS_DELAY_MS=50 php examples/stressTest.php
API_KEY=xxx STRESS_ITERATIONS=1000 php examples/stressTest.php # Pro plans raise the rate limit
```

## Changelog

See [CHANGELOG.md](./CHANGELOG.md) for release notes and migration guidance.

## License

CoinpaprikaAPI is available under the MIT license. See the [LICENSE file](./LICENSE.md) for more info.

coinpaprika-api-php-client

coinpaprika-api-php-client 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

coinpaprika-api-php-client

coinpaprika-api-php-client 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README