Adreskit APIv0.1.0
Doküman
Türkiye verisi için tek anahtar, tek kredi havuzu: adres çözümleme ve doğrulama, IBAN, TCMB kurları, algoritmik TCKN/VKN/telefon kontrolü ve kargo takibi. Aynı araçlar MCP olarak da sunulur (POST /mcp). Hatalar her zaman {"hata": "…"} biçimindedir.
Bu sayfa GET /openapi.json şemasından üretildi (OpenAPI 3.1). Kendi istemcini üretmek için aynı dosyayı kullanabilirsin.
İlk istek
Anahtarını al
Kayıt yakında açılıyor. Anahtar bir kez gösterilecek; biz yalnız özetini saklarız. Anahtarın varsa sonraki adıma geç.
İki değişken tanımla
export ADRESKIT="https://xacw6yute6famacx6a7tjafkfq0hqmug.lambda-url.eu-central-1.on.aws" export ADRESKIT_ANAHTAR="ak_live_…"Bir adres çözümle
curl -X POST "$ADRESKIT/v1/address/resolve" \ -H "authorization: Bearer $ADRESKIT_ANAHTAR" \ -H "content-type: application/json" \ -d '{"q":"kadikoy istanbul moda cad 14"}'
Kimlik ve kredi
Her istek authorization: Bearer ak_live_… başlığıyla gelir. Bütün uçlar aynı kredi havuzundan harcar: ücretsiz planda ayda 1.000 kredi. Her ucun fiyatı aşağıda kendi başlığının yanında yazar; toplu isteklerde adres ya da IBAN başına düşer. Kalan krediyi GET /v1/kullanim ya da panel söyler.
Aynı araçlar uzak MCP olarak da açık: POST /mcp. İstemci kurulumu ana sayfada.
Hatalar
Hata her uçta aynı biçimde döner, yanında anlamlı bir HTTP durum kodu:
{ "hata": "geçersiz API anahtarı" }- 400
- İstek gövdesi eksik ya da hatalı; mesaj hangi alan olduğunu söyler.
- 401
- Anahtar yok, geçersiz ya da iptal edilmiş.
- 429
- Kredi bitti ya da hız sınırı doldu. Varsa
Retry-Afterkaç saniye bekleneceğini söyler. - 503
- Hizmet geçici olarak kapalı; ödeme uçları sağlayıcı açılana kadar bunu döner.
Toplu CSV
Sipariş ya da müşteri dosyasını tek istekte temizle: POST /v1/address/temizle. Gövde dosyanın kendisidir (multipart değil). Yanıt aynı CSV'dir: senin sütunların olduğu gibi kalır, sonuna ak_ önekli 11 sütun eklenir. Aynı işi panelden dosya seçerek de yapabilirsin.
curl -X POST "$ADRESKIT/v1/address/temizle" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR" \
-H "content-type: text/csv" \
--data-binary @siparisler.csv \
-D - -o siparisler-temiz.csv-d değil --data-binary kullan; -d satır sonlarını siler. -D - yanıt başlıklarını ekrana basar: x-adreskit-satir adresi dolu satır sayısı, x-adreskit-kredi düşen kredi, x-adreskit-kodlama dosyanın hangi kodlamayla okunduğu.
Kredi ve sınırlar
Kredi tekil dolu adres başına 1'dir. Dosyada tekrar eden adres bir kez, boş hücre hiç sayılmaz. Dosya en fazla 2,5 MB ve 10.000 veri satırı olabilir; büyüğünü parçalara böl. Dosya ya bütünüyle işlenir ya da kredi düşmez: aşağıdaki hataların hiçbiri kredi yakmaz. Dosya saklanmaz; yalnız kimlik ve adres sütunlarını göndermen yeterli.
Örnek
siparisler.csv
siparis;adres
1001;moda cad 14 kadikoy istanbul
1002;Atatürk Blv. No:5 Kızılay Çankaya Ankara
1003;moda cad 14 kadikoy istanbul
1004;Konak İzmir
1005;siparisler-temiz.csv
siparis;adres;ak_il;ak_ilce;ak_mahalle;ak_yol;ak_bina_no;ak_daire;ak_enlem;ak_boylam;ak_hassasiyet;ak_guven;ak_durum
1001;moda cad 14 kadikoy istanbul;İstanbul;Kadıköy;;Moda Caddesi;14;;40.985993;29.024957;sokak;0.85;tamam
1002;Atatürk Blv. No:5 Kızılay Çankaya Ankara;Ankara;Çankaya;;Atatürk Bulvarı;5;;39.91933;32.854647;sokak;0.85;tamam
1003;moda cad 14 kadikoy istanbul;İstanbul;Kadıköy;;Moda Caddesi;14;;40.985993;29.024957;sokak;0.85;tamam
1004;Konak İzmir;İzmir;Konak;;;;;38.418474;27.139799;ilce;0.4;kismi
1005;;;;;;;;;;;;bosBu dosya için yanıt başlıkları x-adreskit-satir: 4, x-adreskit-kredi: 3 olur: 1001 ile 1003 aynı adres, 1005 boş. Çıktı her zaman UTF-8'dir ve başında BOM vardır ki Excel Türkçe karakterleri doğru açsın. Ayırıcı girdiyle aynı kalır.
ak_il | İl, resmî yazımıyla |
|---|---|
ak_ilce | İlçe |
ak_mahalle | Mahalle; adreste yoksa ya da bulunamazsa boş |
ak_yol | Cadde, sokak ya da bulvar, tam adıyla |
ak_bina_no | Kapı numarası |
ak_daire | Daire |
ak_enlem | Enlem (WGS84) |
ak_boylam | Boylam (WGS84) |
ak_hassasiyet | Koordinatın inceliği: sokak, ilçe (merkez) ya da il (merkez); adresin doğrulanmasından bağımsız |
ak_guven | 0 ile 1 arası güven puanı |
ak_durum | Satırın özeti; aşağıda |
ak_durum değerleri
- tamam
- İl, ilçe ve yol sicilde bulundu.
- kismi
- İl ve ilçe bulundu; yol bulunamadı ya da adreste yazmıyor.
- yalniz_il
- Yalnız il bulundu. Bu satıra elle bak.
- cozulemedi
- İl bile bulunamadı.
- bos
- Adres hücresi boş; kredi düşmez.
Seçenekler
Hepsi isteğe bağlı sorgu parametresidir; varsayılanlar çoğu dosyada doğru çalışır.
- sutun
- Adres sütununun başlık adı ya da 1'den başlayan sırası. Verilmezse
adres,address,açık adres,teslimat adresigibi adlar aranır. - ayirici
auto(varsayılan),,,;ya datab.- kodlama
auto,utf-8ya dawindows-1254. Türkçe Excel'in "CSV" kaydı windows-1254'tür;autoikisini de tanır.- baslik
0verilirse ilk satır veri sayılır; o zamansutunsıra numarası olmalı.
Hatalar
- 400
- CSV bozuk (mesaj satır numarasını söyler) ya da adres sütunu bulunamadı. İkincisinde yanıtta
basliklarda gelir; birinisutunile seç. - 413
- Dosya 2,5 MB'ı ya da 10.000 satırı aşıyor.
- 415
- Gövde CSV değil;
content-type: text/csvgönder. - 429
- Kredi yetmiyor; mesaj bu dosyanın kaç kredi gerektirdiğini söyler.
- 503
- Dosya süre sınırında işlenemedi. Daha küçük parçalarla dene.
Adres
POST/v1/address/resolve
1 kredi
Adres çözümle ve doğrula
Anahtar gerekli
Serbest metin adresi bileşenlerine ayırır, adları sokak sicilinde arar. adresler[] ile toplu (en fazla 1000, adres başına 1 kredi). Koordinat yalnız sokak sicilde koordinatlıysa döner.
| Alan | Tip | Açıklama |
|---|---|---|
q | string | |
adresler | string[] | en fazla 1000 |
Örnek istek
curl -X POST "$ADRESKIT/v1/address/resolve" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR" \
-H "content-type: application/json" \
-d '{"q":"kadikoy istanbul moda cad 14"}'Yanıtlar
- 200Başarılı
AdresSonucu ya da object - 400q ya da adresler eksik, boş ya da metin olmayan eleman
Hata - 401Anahtar yok ya da geçersiz
Hata - 4131000'den fazla adres
Hata - 429Kredi limiti aşıldı
Hata
sonuclar | AdresSonucu[] |
|---|
POST/v1/address/parse
ücretsiz
Yalnız ayrıştır (ücretsiz)
Anahtar gerekli
Sicile bakmaz, koordinat vermez. Anahtar ister ama kredi düşmez.
| Alan | Tip | Açıklama |
|---|---|---|
qzorunlu | string |
Örnek istek
curl -X POST "$ADRESKIT/v1/address/parse" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR" \
-H "content-type: application/json" \
-d '{"q":"ataturk bulv no:12/5 cankaya"}'GET/v1/address/posta-kodu/{kod}
ücretsiz
Posta kodundan ilçe (ücretsiz)
Anahtar gerekli
Kodun gözlendiği ilçeler, POI sayısına göre sıralı; kod birden çok ilçeye yayılıyorsa hepsi döner. Kaynak PTT değil: Overture Maps Places (CDLA-Permissive 2.0) işletme adreslerindeki kodlar. Kapsam eksik (yaklaşık 3.600 kod); bulunamayan kod 404. Mahalle düzeyinde eşleme yok.
| Ad | Yer | Tip | Açıklama |
|---|---|---|---|
kodzorunlu | yol | string |
Örnek istek
curl "$ADRESKIT/v1/address/posta-kodu/<kod>" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR"POST/v1/address/temizle
1 kredi
Toplu adres temizleme (CSV → CSV)
Anahtar gerekli
Gövde ham CSV (multipart değil). Aynı CSV döner: özgün sütunlar olduğu gibi, sona ak_il, ak_ilce, ak_mahalle, ak_yol, ak_bina_no, ak_daire, ak_enlem, ak_boylam, ak_hassasiyet, ak_guven, ak_durum (tamam: il+ilçe+yol sicilde | kismi: il+ilçe | yalniz_il | cozulemedi | bos). Kredi **tekil dolu adres** başına 1; dosya içi tekrar ve boş hücre ücretsiz. Dosya ya bütünüyle işlenir ya da kredi düşmez. En fazla 2,5 MB ve 10.000 veri satırı; büyük dosyayı bölün. Dosya saklanmaz; yalnız kimlik ve adres sütunlarını göndermeniz yeterli.
| Ad | Yer | Tip | Açıklama |
|---|---|---|---|
sutun | sorgu | string | Adres sütununun başlık adı ya da 1'den başlayan sırası. Verilmezse `adres`, `address`, `açık adres`, `teslimat adresi`… aranır. |
ayirici | sorgu | "auto" | "," | ";" | "tab" | |
baslik | sorgu | "1" | "0" | 0: ilk satır veri; `sutun` sıra numarası olmalı |
kodlama | sorgu | "auto" | "utf-8" | "windows-1254" | TR Excel "CSV" kaydı windows-1254; auto ikisini de tanır. Çıktı her zaman UTF-8 (BOM ile). |
Örnek istek
curl -X POST "$ADRESKIT/v1/address/temizle" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR" \
-H "content-type: text/csv" \
--data-binary @siparisler.csv \
-o siparisler-temiz.csvIBAN
POST/v1/iban/dogrula
1 kredi
IBAN doğrula, bankayı çöz
Anahtar gerekli
ISO 13616 mod-97. ibanlar[] ile toplu (en fazla 1000, IBAN başına 1 kredi).
| Alan | Tip | Açıklama |
|---|---|---|
iban | string | |
ibanlar | string[] | en fazla 1000 |
Örnek istek
curl -X POST "$ADRESKIT/v1/iban/dogrula" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR" \
-H "content-type: application/json" \
-d '{"iban":"TR33 0006 1005 1978 6457 8413 26"}'Yanıtlar
- 200Başarılı
IbanSonucu ya da object - 400iban ya da ibanlar eksik, boş ya da metin olmayan eleman
Hata - 401Anahtar yok ya da geçersiz
Hata - 4131000'den fazla IBAN
Hata - 429Kredi limiti aşıldı
Hata
sonuclar | IbanSonucu[] | |
|---|---|---|
ozet | object | |
ozet.toplam | integer | |
ozet.gecerli | integer |
GET/v1/iban/bankalar
ücretsiz
TCMB banka kodu listesi (ücretsiz)
Anahtar gerekli
Örnek istek
curl "$ADRESKIT/v1/iban/bankalar" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR"Yanıtlar
- 200Başarılı
- 401Anahtar geçersiz
Hata
TCMB kuru
GET/v1/kur
ücretsiz
TCMB döviz kurları (ücretsiz)
Anahtar gerekli
Tatil/hafta sonunda en yakın önceki iş gününe düşer; geriyeDusuldu bunu söyler. TCMB ticari kullanımı yazılı izne bağlıyor; izin gelene kadar 0 kredi, not alanıyla.
| Ad | Yer | Tip | Açıklama |
|---|---|---|---|
tarih | sorgu | string (date) | YYYY-AA-GG |
Örnek istek
curl "$ADRESKIT/v1/kur?tarih=2026-09-18" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR"POST/v1/kur/cevir
ücretsiz
Para birimi çevir (TCMB kuru, ücretsiz)
Anahtar gerekli
Yanıttaki kaynak kaynak para birimidir; veri kaynağı veriKaynagi (TCMB).
| Alan | Tip | Açıklama |
|---|---|---|
tutarzorunlu | number | |
kaynakzorunlu | string | |
hedefzorunlu | string | |
kurTipi | "alis" | "satis" | "efektifAlis" | "efektifSatis" | varsayılan "satis" |
tarih | string (date) |
Örnek istek
curl -X POST "$ADRESKIT/v1/kur/cevir" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR" \
-H "content-type: application/json" \
-d '{"tutar":100,"kaynak":"USD","hedef":"TRY"}'Yanıtlar
- 200Başarılı
- 400Eksik alan, bilinmeyen para birimi ya da yayımlanmamış kur
Hata - 401Anahtar yok ya da geçersiz
Hata - 404Yayın bulunamadı
Hata - 429Kredi limiti aşıldı
Hata
veriKaynagi | object | |
|---|---|---|
not | string | |
tutar | number | |
kaynak | string | |
hedef | string | |
sonuc | number | |
kurTipi | string | |
tarih | string | |
geriyeDusuldu | boolean | |
kullanilanKur | object | |
kullanilanKur.kaynak | number | |
kullanilanKur.hedef | number |
GET/v1/kur/ecb
ücretsiz
ECB euro referans kurları (ücretsiz)
Anahtar gerekli
29 para birimi, ECB iş günlerinde ~16:00 CET yayımlar. baz EUR ise değerler ECB'nin yayımladığı gibi; başka bazda ECB kurlarından hesaplanır ve her kurda hesaplanan: true olur. Bu veri ecb.europa.eu'dan ücretsiz alınabilir.
| Ad | Yer | Tip | Açıklama |
|---|---|---|---|
baz | sorgu | string | Üç harfli kod, örn. TRY |
Örnek istek
curl "$ADRESKIT/v1/kur/ecb?baz=…" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR"Yanıtlar
- 200Başarılı
- 400baz geçersiz ya da ECB listesinde yok
Hata - 401Anahtar yok ya da geçersiz
Hata - 429Kredi limiti aşıldı
Hata - 503ECB yayını alınamıyor
Hata
kaynak | string | |
|---|---|---|
not | string | |
hesaplamaNotu | string | Yalnız EUR dışı bazda |
tarih | string | |
baz | string | |
kurlar | object[] | |
kurlar[].kod | string | |
kurlar[].oran | number | 1 baz = oran kod |
kurlar[].hesaplanan | boolean |
TCKN, VKN, telefon
Yalnız algoritma kontrolü; resmî bir kayda sorulmaz. Gönderilen numara veritabanına yazılmaz, TCKN yanıtta dönmez.
POST/v1/dogrula/tckn
1 kredi
TCKN doğrula
Anahtar gerekli
11 hane, ilk hane ≠ 0, iki kontrol hanesi. Numara yanıtta dönmez. tcknler[] ile toplu (en fazla 1000, öğe başına 1 kredi).
| Alan | Tip | Açıklama |
|---|---|---|
tckn | string | |
tcknler | string[] | en fazla 1000 |
Örnek istek
curl -X POST "$ADRESKIT/v1/dogrula/tckn" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR" \
-H "content-type: application/json" \
-d '{"tckn":"10000000146"}'Yanıtlar
- 200Başarılı
KimlikSonucu ya da object - 400tckn ya da tcknler eksik
Hata - 401Anahtar yok ya da geçersiz
Hata - 4131000'den fazla eleman
Hata - 429Kredi limiti aşıldı
Hata
sonuclar | KimlikSonucu[] | Girdi sırasıyla |
|---|---|---|
ozet | object | |
ozet.toplam | integer | |
ozet.gecerli | integer |
POST/v1/dogrula/vkn
1 kredi
VKN doğrula
Anahtar gerekli
GİB kontrol hanesi. 11 hane gelirse şahıs şirketi (VKN = TCKN) sayılır. vknler[] ile toplu (en fazla 1000, öğe başına 1 kredi).
| Alan | Tip | Açıklama |
|---|---|---|
vkn | string | |
vknler | string[] | en fazla 1000 |
Örnek istek
curl -X POST "$ADRESKIT/v1/dogrula/vkn" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR" \
-H "content-type: application/json" \
-d '{"vkn":"1234567890"}'Yanıtlar
- 200Başarılı
KimlikSonucu ya da object - 400vkn ya da vknler eksik
Hata - 401Anahtar yok ya da geçersiz
Hata - 4131000'den fazla eleman
Hata - 429Kredi limiti aşıldı
Hata
sonuclar | KimlikSonucu[] | Girdi sırasıyla |
|---|---|---|
ozet | object | |
ozet.toplam | integer | |
ozet.gecerli | integer |
POST/v1/dogrula/telefon
1 kredi
Telefon doğrula ve biçimle
Anahtar gerekli
BTK numara planı; E.164, tür ve sabit hatta il. Operatör verilmez (numara taşıma). telefonlar[] ile toplu (en fazla 1000, öğe başına 1 kredi).
| Alan | Tip | Açıklama |
|---|---|---|
telefon | string | |
telefonlar | string[] | en fazla 1000 |
Örnek istek
curl -X POST "$ADRESKIT/v1/dogrula/telefon" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR" \
-H "content-type: application/json" \
-d '{"telefon":"0532 123 45 67"}'Yanıtlar
- 200Başarılı
TelefonSonucu ya da object - 400telefon ya da telefonlar eksik
Hata - 401Anahtar yok ya da geçersiz
Hata - 4131000'den fazla eleman
Hata - 429Kredi limiti aşıldı
Hata
sonuclar | TelefonSonucu[] | Girdi sırasıyla |
|---|---|---|
ozet | object | |
ozet.toplam | integer | |
ozet.gecerli | integer |
Kargo
Şimdilik yalnız Yurtiçi Kargo. Gönderen ve alıcı adı yanıtta yer almaz.
GET/v1/kargo/takip
1 kredi
Kargo takip
Anahtar gerekli
Şu an yalnız Yurtiçi. Gönderici/alıcı adı döndürülmez. 5 dakika önbellek.
| Ad | Yer | Tip | Açıklama |
|---|---|---|---|
tasiyicizorunlu | sorgu | "yurtici" | |
nozorunlu | sorgu | string |
Örnek istek
curl "$ADRESKIT/v1/kargo/takip?tasiyici=…&no=…" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR"GET/v1/kargo/tasiyicilar
ücretsiz
Taşıyıcılar ve destek durumu
Anahtarsız
Örnek istek
curl "$ADRESKIT/v1/kargo/tasiyicilar"Yanıtlar
- 200Başarılı
tasiyicilar | object[] |
|---|
Hesap ve anahtar
POST/v1/kayit
ücretsiz
Hesap aç, ilk anahtarı al
Anahtarsız
IP başına saatte 5 kayıt. Anahtar yanıtta bir kez döner, bir daha gösterilmez.
| Alan | Tip | Açıklama |
|---|---|---|
emailzorunlu | string (email) | |
ad | string | |
kaynak | string | Nereden geldiniz (ör. "hn"); isteğe bağlı |
Örnek istek
curl -X POST "$ADRESKIT/v1/kayit" \
-H "content-type: application/json" \
-d '{}'Yanıtlar
- 201Hesap açıldı
- 400Geçersiz e-posta ya da kaynak
Hata - 409E-posta zaten kayıtlı
Hata - 429Kayıt hız sınırı
Hata
hesapId | string | |
|---|---|---|
email | string | |
plan | string | |
anahtar | string | |
uyari | string | |
dogrulama | "gonderildi" | "dogrulanmis" | "hiz_siniri" | "gonderilemedi" | Doğrulama e-postasının durumu (e-posta doğrulaması açıksa) |
baslangic | object | |
baslangic.ornek | string |
POST/v1/anahtar
ücretsiz
Yeni anahtar üret
Anahtar gerekli
En fazla 10 aktif anahtar. Eski anahtar iptal edilmez.
| Alan | Tip | Açıklama |
|---|---|---|
ad | string |
Örnek istek
curl -X POST "$ADRESKIT/v1/anahtar" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR" \
-H "content-type: application/json" \
-d '{}'GET/v1/anahtar
ücretsiz
Anahtarları listele (yalnız önekler)
Anahtar gerekli
Örnek istek
curl "$ADRESKIT/v1/anahtar" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR"DELETE/v1/anahtar/{id}
ücretsiz
Anahtarı iptal et
Anahtar gerekli
| Ad | Yer | Tip | Açıklama |
|---|---|---|---|
idzorunlu | yol | string (uuid) |
Örnek istek
curl -X DELETE "$ADRESKIT/v1/anahtar/<id>" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR"GET/v1/kullanim
ücretsiz
Kalan kredi
Anahtar gerekli
Örnek istek
curl "$ADRESKIT/v1/kullanim" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR"Ödeme
Kredi paketleri yakında. Ödeme sağlayıcıları açılana kadar ödeme başlatma ucu 503 döner.
GET/v1/paketler
ücretsiz
Kredi paketleri ve fiyatlar
Anahtarsız
Örnek istek
curl "$ADRESKIT/v1/paketler"Yanıtlar
- 200Başarılı
paketler | object[] | |
|---|---|---|
paketler[].kod | string | |
paketler[].ad | string | |
paketler[].kredi | integer | |
paketler[].fiyat | object | |
not | string |
POST/v1/odeme
ücretsiz
Ödeme başlat
Anahtar gerekli
TRY → PayTR, USD → Polar. Sağlayıcı yapılandırılmamışsa 503.
| Alan | Tip | Açıklama |
|---|---|---|
paketzorunlu | string | |
paraBirimi | "TRY" | "USD" |
Örnek istek
curl -X POST "$ADRESKIT/v1/odeme" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR" \
-H "content-type: application/json" \
-d '{"paket":"baslangic","paraBirimi":"TRY"}'GET/v1/odeme
ücretsiz
Ödeme geçmişi
Anahtar gerekli
Örnek istek
curl "$ADRESKIT/v1/odeme" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR"MCP
POST/mcp
Uzak MCP (Streamable HTTP, stateless)
Anahtar yalnız araç çağrısında
Model Context Protocol JSON-RPC ucu. Anahtar yalnız tools/call için gerekli; initialize, tools/list ve ping anahtarsız ve ücretsiz. Anahtarsız tek tools/call 401 anlamında isError döner; içinde tools/call olan anahtarsız toplu istek 401. Kredi, çağrılan aracın REST ucu kadar düşer. Yanıt JSON, SSE yok. Accept: application/json, text/event-stream gerekli.
Gövde: JSON-RPC 2.0 mesajı.
Örnek istek
curl -X POST "$ADRESKIT/mcp" \
-H "accept: application/json, text/event-stream" \
-H "content-type: application/json" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'Yanıtlar
- 200Başarılı
- 400Geçersiz JSON (JSON-RPC -32700)
- 401Anahtarsız toplu istekte tools/call
Demo
POST/v1/demo/adres
ücretsiz
Anahtarsız adres çözümleme (tanıtım)
Anahtarsız
Tanıtım sayfasındaki canlı kutu için. Anahtar istemez, kredi düşmez. Yalnız tek adres, en fazla 200 karakter. IP başına 10 dakikada 20 istek; aşılınca 429 ve Retry-After.
| Alan | Tip | Açıklama |
|---|---|---|
qzorunlu | string | en fazla 200 karakter |
Örnek istek
curl -X POST "$ADRESKIT/v1/demo/adres" \
-H "content-type: application/json" \
-d '{"q":"kadikoy moda cad 14"}'Yanıtlar
- 200Başarılı
AdresSonucu - 400q eksik ya da çok uzun
Hata - 429Demo sınırı doldu
Hata
Sistem
GET/health
Canlılık
Anahtarsız
Örnek istek
curl "$ADRESKIT/health"Yanıtlar
- 200Başarılı
ok | boolean |
|---|
GET/openapi.json
Bu şema
Anahtarsız
Örnek istek
curl "$ADRESKIT/openapi.json"Yanıtlar
- 200Başarılı
eposta
GET/v1/eposta/dogrula
E-posta adresini doğrula (e-postadaki bağlantı)
Anahtarsız
| Ad | Yer | Tip | Açıklama |
|---|---|---|---|
kodzorunlu | sorgu | string |
Örnek istek
curl "$ADRESKIT/v1/eposta/dogrula?kod=…"POST/v1/eposta/dogrulama-gonder
ücretsiz
Doğrulama e-postasını yeniden gönder
Anahtar gerekli
Saatte en fazla 3. Bağlantı 24 saat geçerli; yeni bağlantı eskisini geçersiz kılar.
Örnek istek
curl -X POST "$ADRESKIT/v1/eposta/dogrulama-gonder" \
-H "authorization: Bearer $ADRESKIT_ANAHTAR"POST/v1/kurtar
Anahtar kurtarma kodu iste
Anahtarsız
Hesap olsun olmasın aynı yanıt döner. Kod e-postayla gelir, 30 dakika geçerli. IP başına saatte 5, hesap başına saatte 3 istek.
| Alan | Tip | Açıklama |
|---|---|---|
emailzorunlu | string (email) |
Örnek istek
curl -X POST "$ADRESKIT/v1/kurtar" \
-H "content-type: application/json" \
-d '{}'POST/v1/kurtar/onay
Kurtarma koduyla yeni anahtar al
Anahtarsız
eskileriIptal: true önceki bütün anahtarları kapatır. Kod tek kullanımlık; anahtar yanıtta bir kez döner.
| Alan | Tip | Açıklama |
|---|---|---|
kodzorunlu | string | |
eskileriIptal | boolean | varsayılan false |
Örnek istek
curl -X POST "$ADRESKIT/v1/kurtar/onay" \
-H "content-type: application/json" \
-d '{}'Şemalar
Hata
hataher zaman | string |
|---|
Ayrisma
mahalle | string | |
|---|---|---|
koy | string | |
yolAdi | string | |
yolTipi | string | |
binaNo | string | |
daire | string | |
kat | string | |
blok | string | |
bina | string | |
site | string | |
postaKodu | string | |
serbest | string[] | Çapaya bağlanamayan kelimeler |
duzeltmeler | string[] |
AdresSonucu
il | string | |
|---|---|---|
ilce | string | |
mahalle | string | |
yol | string | |
binaNo | string | |
daire | string | |
kat | string | |
lat | number | |
lon | number | |
hassasiyether zaman | "sokak" | "mahalle" | "ilce" | "il" | "yok" | Koordinatın ayrıntı düzeyi (bileşenin bulunup bulunmadığı değil). `mahalle` şimdilik üretilmiyor |
dogrulananher zaman | object | Hangi bileşenin resmî sicilde bulunduğu; koordinattan bağımsız |
dogrulanan.il | boolean | |
dogrulanan.ilce | boolean | |
dogrulanan.mahalle | boolean | |
dogrulanan.yol | boolean | |
guvenher zaman | number | 0–1 |
duzeltmelerher zaman | string[] | Yapılan düzeltmelerin okunur dökümü |
ayrismaher zaman | Ayrisma |
IbanSonucu
gecerliher zaman | boolean | |
|---|---|---|
iban | string | |
bicimli | string | |
ulke | string | |
bankaKodu | string | |
hesapNo | string | |
banka | object | |
hata | "bos" | "gecersiz_karakter" | "bilinmeyen_ulke" | "uzunluk" | "kontrol_basamagi" | "tr_ayrilmis_hane" | |
aciklama | string |
Kur
kod | string | |
|---|---|---|
ad | string | |
adEn | string | |
birim | integer | TCMB kote birimi (JPY 100); kurlar 1 birime indirgenmiş |
alis | number | null | |
satis | number | null | |
efektifAlis | number | null | |
efektifSatis | number | null |
KimlikSonucu
gecerliher zaman | boolean | |
|---|---|---|
tur | "vkn" | "tckn" | Yalnız VKN ucunda |
vkn | string | Yalnız geçerli 10 haneli VKN |
hata | "bos" | "gecersiz_karakter" | "uzunluk" | "ilk_hane_sifir" | "kontrol_10" | "kontrol_11" | "kontrol_basamagi" | |
aciklama | string | |
nother zaman | string |
TelefonSonucu
gecerliher zaman | boolean | |
|---|---|---|
e164 | string | null | +905321234567; 444 numaralarında null |
ulusal | string | 0532 123 45 67 |
tur | "gsm" | "m2m" | "sabit" | "ucretsiz_800" | "katma_degerli_900" | "ulusal_850" | "kurumsal_444" | |
il | string | Yalnız sabit hatlarda |
hata | "bos" | "gecersiz_karakter" | "yabanci_ulke" | "uzunluk" | "tanimsiz_onek" | |
aciklama | string |
KargoKonum
il | string | null | |
|---|---|---|
ilce | string | null | |
ulke | string | null |
KargoSonucu
tasiyiciher zaman | string | |
|---|---|---|
takipNoher zaman | string | |
bulunduher zaman | boolean | |
mesaj | string | Yalnız bulundu=false |
durum | "hazirlaniyor" | "yolda" | "dagitimda" | "teslim_edildi" | "iade" | "bilinmiyor" | |
durumMetni | string | null | |
teslimEdildi | boolean | |
gonderiTarihi | string | null | |
tahminiTeslim | string | null | |
cikis | KargoKonum | |
varis | KargoKonum | |
teslimBirimi | object | null | |
teslimBirimi.ad | string | null | |
teslimBirimi.telefon | string | null | |
hareketler | object[] | |
hareketler[].tarih | string | null | |
hareketler[].yer | string | null | |
hareketler[].aciklama | string | null |
Şema derleme anında https://xacw6yute6famacx6a7tjafkfq0hqmug.lambda-url.eu-central-1.on.aws/openapi.json ucundan alındı.