README.md

Youtube-Channel-Badge

A shields.io API for your youtube channel to protect your api key.

Table of contents

• Why
• Features
• Examples
  • URLs
  • Styles
• Configuration
  • Getting a google api key & activate youtube api
  • Find your youtube channel id
• Deployment
  • Step by Step
• Usage

Why

You can't publicly access the google/youtube api without an api key. That's why there is no shields.io badge for youtube channels. This repo aims to be the solution to this, because you deploy your own public api which only fetches your channel.

Features

• Cache time to prevent rate limiting
• Secure api key due env variable

Examples

Urls

Name	Example	Description	URL
Subscriber count		Shows the amount of subscribers	/subscriber
View count		Shows the amount of views of all videos of the channel	/views
Video count		Shows the amount of videos on the channel	/videos
Comment count		Shows the amount of youtube comments of the channel	/comments

Styles

Name	Examples
plastic
flat
flat-square
for-the-badge
social

All examples are live and based on my youtube channel: ntec.io

Configuration

Variable Name	Description	Required
API_KEY	Your google api key. See section below on how to get one	TRUE
CHANNEL_ID	The youtube channel id of which the stats should be processed	TRUE
CACHE_TIME	Time in seconds on how long the last result is cached. Default is 300.	FALSE

Getting a google api key & activate youtube api

1. Go to google developer console

2. Log In to your google account

3. Click on Select a project (Looks like a dropdown button)

   

4. Create a new project by clicking on the New Project button

   

5. Give your project a name (or leave it to the generated one) and create your project by pressing on CREATE

   

6. On the next window, click on + ENABLE APIS AND SERVICES in the top

   

7. Search for Youtube in the search bar and click on YoTube Data API v3

   

8. Enable the API by clicking on ENABLE

   

9. Click on the 3 lines in the top left corner to open the side menu and hover over APIs & Services and then click on Credentials

   

10. Click on CREATE CREDENTIALS and then on API key

    

11. Copy your API key

    

Find your youtube channel id

1. Goto your advanced account settings

2. Copy your channel id

   

Deployment

It is neccessary to deploy this repo by yourself to get a domain for the desired youtube channel. An easy and free way to deploy this repo is by using vercel. Just use the button below.

Step by step

1. Click on the deploy button above or click here

2. Click on Continue

   

3. Click on no

   

4. Select your user account and click on continue

   

5. Fork the repo with a click on continue

   

6. Click again on Continue

   

7. Enter your API_KEY, CHANNEL_ID and CACHE_TIME. Check Configuration if you need help getting those things.

   

8. Click on Deploy and your deployment should finish after a short time

   

Usage

1. Deploy the repo and get your url from domains

   Example in vercel:

   

2. Go to shields.io/endpoint and scroll down

   

3. Add your vercel url to the url field

4. Add your wanted url suffix:

   • to get the subscriber count: add api/subscriber

   • to get the view count: add api/views

   • to get the comment count: add api/comments

   • to get the video count: add api/videos

   It should look like this:

   

5. Override the labels/colors/logo if you want (optional)

6. Click on the button to copy the badge url

   

7. Enjoy! :)