Coinfeeds API

API Reference

The Coinfeeds API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL

https://api.coinfeeds.io

Authentication

The Coinfeeds API uses API key (x-api-key) to authenticate the request. Use API key in the header for any request.

For your personal API key, send us an email at help@coinfeeds.io

We strongly recommend using a secrets manager. Plain text files like dotenv lead to accidental costly leaks. Use Doppler for a developer friendly experience. AWS and Google Cloud have native solutions as well.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Authenticated Request

curl --location --request GET 'https://api.coinfeeds.io/coins/list' \

--header 'x-api-key: <api-key>'

API Endpoints

GET /coins/list

Get list of coins supported

Response Schema

1
{
2
  "coins": [
3
    {
4
      "id": "string",
5
      "symbol": "string",
6
      "name": "string"
7
    }
8
  ]
9
}

cURL Request

curl --location --request GET 'https://api.coinfeeds.io/coins/list' \

--header 'x-api-key: <api-key>'

GET /coins/news

Get news for a list of coins.

Parameters

coins string *required

Comma separated list of all the coins

symbol boolean

Whether to use symbol or id for fetching data. If true, then coins should be a comma separated list of coin symbols else it should be a comma separated list of coin ids.

Response Schema

1
{
2
  "newsFeed": [
3
    {
4
      "url": "string",
5
      "title": "string",
6
      "image": "string",
7
      "summary": "string",
8
      "newsSiteName": "string",
9
      "newsSiteLogo": "string",
10
      "publishDate": "number",
11
      "language": "string"
12
    }
13
  ]
14
}

cURL Request

curl --location --request GET 'https://api.coinfeeds.io/coins/news' \

--header 'x-api-key: <api-key>'

GET /coins/{coin_name}/news

Get news for a single coin

Parameters

coin_name string *required

Name of the coin

symbol boolean

Whether to use symbol or id for fetching data. If true, then coin_name should be the coin symbol else it should be coin id

Response Schema

1
{
2
  "newsFeed": [
3
    {
4
      "url": "string",
5
      "title": "string",
6
      "image": "string",
7
      "summary": "string",
8
      "newsSiteName": "string",
9
      "newsSiteLogo": "string",
10
      "publishDate": "number",
11
      "language": "string"
12
    }
13
  ]
14
}

cURL Request

curl --location --request GET 'https://api.coinfeeds.io/coins/{coin_name}/news' \

--header 'x-api-key: <api-key>'

GET /coins/{coin_name}/tweets

Get id of all the tweets for a particular coin

Parameters

coin_name string *required

Name of the coin

symbol boolean

Whether to use symbol or id for fetching data. If true, then coin_name should be the coin symbol else it should be coin id

Response Schema

1
{
2
  "tweet_ids": [
3
    "string"
4
  ]
5
}

cURL Request

curl --location --request GET 'https://api.coinfeeds.io/coins/{coin_name}/tweets' \

--header 'x-api-key: <api-key>'

GET /coins/{coin_name}/podcasts

Get id of all the spotify podcasts for a particular coin

Parameters

coin_name string *required

Name of the coin

symbol boolean

Whether to use symbol or id for fetching data. If true, then coin_name should be the coin symbol else it should be coin id

Response Schema

1
{
2
  "podcast_ids": [
3
    "string"
4
  ]
5
}

cURL Request

curl --location --request GET 'https://api.coinfeeds.io/coins/{coin_name}/podcasts' \

--header 'x-api-key: <api-key>'

GET /coins/{coin_name}/videos

Get id of all the youtube videos for a particular coin

Parameters

coin_name string *required

Name of the coin

symbol boolean

Whether to use symbol or id for fetching data. If true, then coin_name should be the coin symbol else it should be coin id

Response Schema

1
{
2
  "video_ids": [
3
    "string"
4
  ]
5
}

cURL Request

curl --location --request GET 'https://api.coinfeeds.io/coins/{coin_name}/videos' \

--header 'x-api-key: <api-key>'