https://github.com/coinpaprika/coinpaprika-api-go-client

Go client library for interacting with Coinpaprika's API
https://github.com/coinpaprika/coinpaprika-api-go-client

Last synced: 10 days ago
JSON representation

Go client library for interacting with Coinpaprika's API

• Host: GitHub
• URL: https://github.com/coinpaprika/coinpaprika-api-go-client
• Owner: coinpaprika
• License: mit
• Created: 2018-09-25T07:34:50.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-05T05:18:48.000Z (11 months ago)
• Last Synced: 2024-07-30T20:44:38.167Z (3 months ago)
• Language: Go
• Homepage:
• Size: 160 KB
• Stars: 23
• Watchers: 7
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-go - coinpaprika-go - Go client library for interacting with Coinpaprika's API. (Third-party APIs / Utility/Miscellaneous)
• awesome-go - coinpaprika-api-go-client - Go client library for interacting with Coinpaprika's API - ★ 3 (Third-party APIs)
• awesome-go-extra - coinpaprika-api-go-client - 09-25T07:34:50Z|2020-09-16T05:09:30Z| (Third-party APIs / Fail injection)

README

        
# Coinpaprika API Go Client

[![Build Status](https://travis-ci.org/coinpaprika/coinpaprika-api-go-client.svg?branch=master)](https://travis-ci.org/coinpaprika/coinpaprika-api-go-client)

[![go-doc](https://godoc.org/github.com/coinpaprika/coinpaprika-api-go-client?status.svg)](https://godoc.org/github.com/coinpaprika/coinpaprika-api-go-client/coinpaprika)

[![Go Report Card](https://goreportcard.com/badge/github.com/coinpaprika/coinpaprika-api-go-client)](https://goreportcard.com/report/github.com/coinpaprika/coinpaprika-api-go-client)

## Usage

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

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

## Getting started

```go

package main

import (

	"fmt"

	"github.com/coinpaprika/coinpaprika-api-go-client/coinpaprika"

)

func main() {

	paprikaClient := coinpaprika.NewClient(nil)

	tickers, err := paprikaClient.Tickers.List(nil)

	if err != nil {

		panic(err)

	}

	for _, t := range tickers {

		if t.Name == nil || t.Symbol == nil || t.Rank == nil {

			continue

		}

		fmt.Println("Name:", *t.Name)

		fmt.Println("Symbol:", *t.Symbol)

		fmt.Println("Rank:", *t.Rank)

		fmt.Println("----")

	}

}

```

## Setting custom HTTP client

```go

customClient := &http.Client{Timeout: 10 * time.Second}

paprikaClient := coinpaprika.NewClient(customClient)

```

## Setting API key for and enabling access to Coinpaprika Pro API

Key can be obtained from [Coinpaprika API](https://coinpaprika.com/api/)

```go

paprikaClient := coinpaprika.NewClient(nil, coinpaprika.WithAPIKey("your_api_key_goes_here"))

```

## Examples

Check out the [`./examples`](./examples) directory.

## Implementation status

### Global

- [x] Get market overview data

### Coins

- [x] List coins

- [x] Get coin by ID

- [x] Get twitter timeline for coin

- [x] Get coin events by coin ID

- [x] Get exchanges by coin ID

- [x] Get markets by coin ID

- [x] Get latest OHLCV

- [x] Get historical OHLCV

### People

- [x] Get people by ID

### Tags

- [x] List tags

- [x] Get tag by ID

### Tickers 

- [x] Get tickers for all coins

- [x] Get ticker information for specific coin

- [x] Get historical tickers for specific coin

### Exchanges

- [x] List exchanges

- [x] Get exchange by ID

- [x] List markets by exchange ID

### Search

- [x] Search tool

### Price Converter

- [x] Price converter

## License

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