https://github.com/jefrydco/cari-teks-video-api
API service for searching text in YouTube Closed Captions
https://github.com/jefrydco/cari-teks-video-api
api open-api subtitle youtube
Last synced: about 1 year ago
JSON representation
API service for searching text in YouTube Closed Captions
- Host: GitHub
- URL: https://github.com/jefrydco/cari-teks-video-api
- Owner: jefrydco
- License: mit
- Created: 2020-07-07T16:42:00.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-02T00:01:54.000Z (about 1 year ago)
- Last Synced: 2025-04-02T01:19:16.019Z (about 1 year ago)
- Topics: api, open-api, subtitle, youtube
- Language: TypeScript
- Homepage: https://awesome-cari-teks-video.netlify.app
- Size: 195 KB
- Stars: 12
- Watchers: 3
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: readme-id.md
- License: license.md
Awesome Lists containing this project
README
# Cari Teks Video API
> Layanan API untuk mencari teks pada _caption_ YouTube
## Daftar Isi
- [Bahasa](#-bahasa)
- [Deskripsi](#deskripsi)
- [Daftar Keren](#daftar-keren)
- [Dokumentasi API](#dokumentasi-api)
- [Request](#request)
- [Response](#response)
- [Contoh](#contoh)
- [Penyangkalan](#penyangkalan)
- [Perizinan](#perizinan)
## 🌎 Bahasa
Baca deskripsi ini dalam bahasa lain:
- [🇬🇧 English](./readme.md)
## Deskripsi
API ini semula digunakan untuk latihan pada webinar Vue.js Fundamental. Teman-teman dapat melihat rekaman ulangnya di [YouTube: Vue.js Fundamental](https://www.youtube.com/watch?v=kvDxWcxhh7c). Jika teman-teman penasaran bagaimana API ini bekerja di balik layar, teman-teman dapat mempelajarinya pada blog saya, [Jefrydco: Bagaimana Jika Kita Dapat Mencari Kata Kunci Apapun dari Video YouTube Manapun Melalui Captionnya?](https://jefrydco.id/blog/search-closed-captions-text-youtube-video/).
## Daftar Keren
Teman-teman dapat melihat daftar aplikasi keren yang dibuat menggunakan API ini di https://awesome-cari-teks-video.netlify.app.
## Dokumentasi API
Setiap URL YouTube **membutuhkan waktu yang lebih lama untuk _request_ pertama kali** dan **di-_cache_ pada _request_ berikutnya**.
### _Request_
URL: https://cari-teks-video-api.vercel.app/api/search
Method: POST
Parameter Kueri:
| Nama Parameter | Tipe Data | Contoh Nilai | Nilai Anggapan | Wajib Ada? | Deskripsi |
|----------------|------------------|---------------------------------------------|----------------|------------|-------------------------------------------------------------------------------|
| url | String | https://www.youtube.com/watch?v=okpg-lVWLbE | - | Yes | URL video YouTube yang ingin kita cari kata-katanya |
| q | String | web | - | Yes | Kata kunci yang digunakan |
| page | Number | 1 | 1 | No | Memfilter hasil pencarian berdasarkan halaman |
| size | Number | 10 | 10 | No | Memfilter seberapa banyak hasil pencarian yang tampil dalam sekali permintaan |
| marked | Boolean (0 or 1) | 1 | 1 | No | Mencetak tebal kata kunci di hasil pencarian |
| paginated | Boolean (0 or 1) | 1 | 1 | No | Membuat paginasi untuk hasil pencarian atau tidak |
### _Response_
| Nama Kunci | Tipe Data | Contoh Nilai | Deskripsi |
|------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| data | Array | `[{start: 1000, end: 1200, text: “lorem ipsum”}]` | Daftar hasil pencarian |
| meta | Record | `{title: "6 Problems with our School System", channelName: "Next School", channelUrl: "https://www.youtube.com/channel/UCEb1b2lWpBA0Ux4wi8A4yJA", channelLogoUrl: "https://yt3.ggpht.com/ytc/AAUvwnj74okT3YeIm_HwnkAtiOTVzzcrirBRm7HJcAf1=s68-c-k-c0x00ffffff-no-rj"}` | Data meta dari video |
| first | String | https://cari-teks-video-api.vercel.app/api/search?page=1&q=education&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3Dokpg-lVWLbE | Tautan halaman pertama dari hasil pencarian |
| last | String | https://cari-teks-video-api.vercel.app/api/search?page=23&q=education&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3Dokpg-lVWLbE | Tautan halaman terakhir dari hasil pencarian |
| prev | String | null | https://cari-teks-video-api.vercel.app/api/search?page=1&q=education&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3Dokpg-lVWLbE | Tautan halaman sebelumnya dari hasil pencarian. Jika nilainya null berarti hasil pencarian tersebut tidak memiliki halaman sebelumnya |
| next | String | null | https://cari-teks-video-api.vercel.app/api/search?page=3&q=education&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3Dokpg-lVWLbE | Tautan halaman selanjutnya dari hasil pencarian. Jika nilainya null berarti hasil pencarian tersebut tidak memiliki halaman selanjutnya. |
| total | Number | 229 | Total item hasil pencarian |
| page | Number | 2 | Halaman pencarian sekarang |
Setiap item di data berisi:
| Key | Data Type | Example Value | Description |
|-------|-----------|-----------------------------------------------------------------------------------------|---------------------------------------------------|
| start | Number | 20 | Detik ke-berapa kata kunci yang dimaksud dimulai |
| end | Number | 22 | Detik ke-berapa kata kunci yang dimaksud berakhir |
| text | String | "that the current system of <mark class=\"cvt-highlight\">education</mark>" | Teks yang mengandung kata kunci yang dimaksud |
### Contoh
```shell
curl -XPOST 'https://cari-teks-video-api.vercel.app/api/search?q=education&url=https://www.youtube.com/watch?v=okpg-lVWLbE'
# Response
{
"data": [
{
"start": 2,
"end": 5,
"text": "that something is wrong with our system of education."
},
{
"start": 20,
"end": 22,
"text": "that the current system of education"
},
{
"start": 222,
"end": 225,
"text": "There seems to be no room in the current education system"
},
{
"start": 330,
"end": 332,
"text": "Our system of education,"
},
{
"start": 345,
"end": 349,
"text": "fundamentally change our system of education."
}
],
"meta": {
"title": "6 Problems with our School System",
"channelName": "Next School",
"channelUrl": "https://www.youtube.com/channel/UCEb1b2lWpBA0Ux4wi8A4yJA",
"channelLogoUrl": "https://yt3.ggpht.com/ytc/AAUvwnj74okT3YeIm_HwnkAtiOTVzzcrirBRm7HJcAf1=s68-c-k-c0x00ffffff-no-rj"
},
"first": "https://cari-teks-video-api.vercel.app/api/search?page=1&q=education&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3Dokpg-lVWLbE",
"last": "https://cari-teks-video-api.vercel.app/api/search?page=1&q=education&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3Dokpg-lVWLbE",
"prev": null,
"next": null,
"total": 5,
"page": 1
}
```
## Penyangkalan
1. "Metode" mengarah ke langkah-langkah atau penjelasan yang saya tulis pada artikel ini, [Jefrydco: Bagaimana Jika Kita Dapat Mencari Kata Kunci Apapun dari Video YouTube Manapun Melalui Captionnya?](https://jefrydco.id/blog/search-closed-captions-text-youtube-video/).
2. "API" mengarah ke semua API yang tersedia pada https://cari-teks-video-api.vercel.app/api.
3. Semua metode ini murni **bertujuan untuk riset dan eksperimen**.
4. Jika YouTube memutuskan untuk mengubah skema API _caption_ atau menggunakan cara lain, metode ini **kemungkinan tidak dapat digunakan**.
5. Karena API yang dibuat di-_host_ pada versi gratis dari Vercel yang memiliki beberapa batasan. Salah satunya adalah berapa banyak pemanggilan fungsi. Jika API tersebut tiba-tiba tidak dapat diakses, kemungkinan telah melewati batasan tersebut.
6. Karena poin nomor 4 dan 5, saya **tidak dapat menjamin API tersebut akan dapat digunakan secara terus-menerus**. Tetapi saya akan melakukan pengecekan secara reguler untuk memastikannya tetap berjalan baik.
7. **Jangan gunakan untuk _production_**. Saya tidak akan bertanggung jawab terhadap dampak apapun yang ditimbulkan dari penggunaan tersebut.
8. YouTube memiliki [API Data YouTube untuk _Caption_](https://developers.google.com/youtube/v3/docs/captions?hl=id) untuk menyediakan cara resmi mengakses _caption_. Silahkan **gunakan layanan ini jika teman-teman ingin menggunakan fitur serupa untuk _production_**.
9. Jika teman-teman menemukan bug, silahkan mengirimkan _issue_ di repositori GitHub berikut, [Cari Teks Video API](https://github.com/jefrydco/cari-teks-video-api/blob/main/readme-id.md#readme).
## Perizinan
Kode sumber berlisensi [MIT](./license.md).