Dokumentasi API Hop
SimilarwebAPI
Kueri lalu lintas situs, kata kunci pencarian, backlink, rujukan, pesaing, dan interaksi melalui endpoint REST terautentikasi.
SimilarwebAPI menyediakan 27 endpoint data hanya-baca di bawah /v1/similarweb. Gunakan akun, API key, saldo, dan riwayat penggunaan yang sama seperti API API Hop lainnya. Ketersediaan bergantung pada gateway yang diaktifkan dan izin API key Anda; dokumentasi tidak mengonfirmasi ketersediaan produksi.
Autentikasi
Kirim API key API Hop Anda, bukan kredensial pihak ketiga:
Authorization: Bearer YOUR_API_KEYContoh Permintaan
Semua operasi publik menggunakan GET dengan parameter kueri dan tanpa isi permintaan. Pertahankan kapitalisasi jalur dan parameter persis seperti yang didokumentasikan.
Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara.
Untuk endpoint yang menerima tanggal, rentang from/to eksplisit yang valid dan lengkap diprioritaskan. Pada endpoint yang menerima latest, nilai yang diberikan tetap harus lolos validasi format yang ada dan validasi khusus endpoint, tetapi diabaikan untuk pemilihan rentang dan tidak dikirim ke Similarweb; tidak ada latest bawaan yang ditambahkan. Tanpa rentang eksplisit, perilaku latest, nilai bawaan, dan jendela yang ada tidak berubah. Pembatasan riwayat tetap berlaku, dan endpoint yang tidak menerima latest tetap menolaknya.
curl --get "https://api.apihop.ai/v1/similarweb/websites/incoming-referrals" \
-H "Authorization: Bearer YOUR_API_KEY" \
--data-urlencode "key=example.com" \
--data-urlencode "country=999" \
--data-urlencode "page=1"Rujukan masuk menggunakan hostname key huruf kecil tunggal, bukan keys. key ini adalah parameter kueri bisnis untuk situs target, bukan kredensial API; hanya diizinkan pada rute GET Similarweb yang secara khusus masuk daftar izin. Autentikasi API tetap menggunakan Authorization dan kolom kueri kredensial lainnya tetap dilarang. Barisnya dikembalikan dalam Records, bukan Data. Lihat referensi endpoint lengkap untuk kolom yang tepat pada setiap operasi.
Cakupan
- Pencarian: saran kata kunci, halaman peringkat, kata kunci situs, pencarian organik dan berbayar, kata kunci bermerek.
- Lalu lintas situs: interaksi, kunjungan, geografi, komposisi perangkat, kanal, dan lalu lintas sosial.
- Hubungan: backlink, rujukan masuk, lalu lintas keluar, dan situs serupa.
- Riwayat: rangkaian terpisah untuk kunjungan bulanan, rasio pentalan, durasi kunjungan, dan halaman per kunjungan.
Respons
Respons berhasil mempertahankan isi JSON native, tanpa envelope success/data baru. Nama kolom, kolom yang tidak dikenal, larik kosong, dan presisi numerik tidak berubah. Endpoint berbeda dapat mengembalikan Data, Records, atau bentuk native lain; jangan menganggap ada satu kolom baris universal.
Hasil kosong yang berhasil bukan berarti domain tidak memiliki lalu lintas. Permintaan yang gagal tidak boleh dianggap sebagai data kosong. Simpan X-Request-Id dan waktu permintaan untuk pemecahan masalah.
Penagihan dan Paginasi
Harga standar adalah $0.0005 per permintaan berhasil, atau $0.50 per 1,000 permintaan, di seluruh 27 endpoint. Penagihan per permintaan, bukan per baris; hasil kosong yang berhasil tetap dihitung sebagai satu permintaan. Setiap halaman berikutnya adalah permintaan terpisah. Harga khusus akun diprioritaskan jika dikonfigurasi. Permintaan dengan parameter tidak valid, otorisasi tidak ada, atau saldo tidak cukup tidak diteruskan sebagai panggilan berhasil yang dapat ditagih. Permintaan upstream yang gagal tidak dikenai biaya.
Akun Anda harus memiliki minimal $0.10 yang tersedia sebelum panggilan, sesuai kebijakan saldo minimum platform. Biaya standar tetap $0.0005 per permintaan berhasil.
Gunakan hanya kolom paginasi yang didokumentasikan untuk endpoint yang dipilih. Paginasi umumnya berbasis 1; backlink menggunakan Page dan PageSize, sedangkan tabel lain dapat menggunakan page, pageSize, atau rowsPerPage. Jangan mengirim kolom ukuran halaman yang tidak didukung.
Kesalahan
Kesalahan platform menggunakan bentuk berikut; code adalah kode bisnis platform, bukan status HTTP:
{"success":false,"error":{"code":10000,"message":"Invalid request parameters"},"requestId":"..."}Status HTTP umum mencakup 400 kueri tidak valid, 401 API key tidak valid, 402 saldo tidak cukup, 403 akses gateway ditolak, 429 batas laju, dan 5xx kegagalan sementara upstream atau layanan. Jangan mencoba ulang permintaan berformat salah tanpa perubahan.