Panduan
Aturan query
Parameter yang tersedia mengikuti referensi setiap endpoint. Gunakan aturan berikut agar permintaan tetap terukur dan hasilnya mudah ditelusuri.
Pagination
Endpoint berpaginasi mencantumkan header X-Page dan X-PageSize. Nomor halaman dimulai dari 1 dan ukuran halaman maksimum mengikuti deskripsi operasinya.
X-Page: 1
X-PageSize: 25Respons endpoint tersebut mengembalikan posisi halaman melalui X-Page, ukuran halaman melalui X-PageSize, dan jumlah seluruh data yang cocok melalui X-TotalCount. Gunakan header response ini untuk membangun navigasi halaman; jangan menebak jumlah data dari panjang array.
Filter dan urutan data
Gunakan endpoint berakhiran -option untuk memperoleh nilai filter yang valid. Parameter array dapat dikirim berulang sesuai contoh pada referensi operasi.
Jika operasi mendukung pengurutan, kirim header X-Sort dengan format field;asc atau field;desc. Beberapa aturan dapat dipisahkan dengan koma.
X-Sort: Date;desc,Name;ascPola filter screener
Keempat screener menggunakan pasangan property operator dan nilai. Nama pastinya tetap mengikuti request schema setiap screener.
| Operator | Arti | Nilai yang digunakan |
|---|---|---|
1 | Kurang dari atau batas maksimum. | *Value |
2 | Lebih dari atau batas minimum. | *Value |
3 | Berada di antara dua batas. | *Value dan *Value2 |
Jangan mengirim *Value2 tanpa operator rentang. Gunakan endpoint option untuk field kategorikal seperti instrumen, sektor, mata uang, rating, benchmark, atau manajer investasi.
Aturan tanggal
- Gunakan format ISO
YYYY-MM-DDuntuk parameter tanggal kecuali skema operasi menentukan format lain. - Jangan mengubah zona waktu atau mengubah nilai tanggal menjadi timestamp tanpa ketentuan yang jelas.
- Bedakan tanggal observasi, periode laporan, tanggal efektif, dan waktu publikasi.
Nilai kosong dan nol
Nilai 0 adalah nilai bisnis yang valid. Jangan menyamakannya dengan null, kolom yang tidak tersedia, atau teks kosong.