आपको इस सप्ताह अपने ऐप में एक दिए गए अमेरिकी ज़िप कोड के लिए अपराध ग्रेड और श्रेणी का विभाजन दिखाना है। इस गाइड के अंत तक, आप एक ज़िप के लिए अपराध ग्रेड और दरें मांगने, प्रतिक्रिया को पार्स करने और इसे एक छोटे, उत्पादन-तैयार एकीकरण के साथ भेजने में सक्षम होंगे।
यह एपीआई आपको क्या देता है
ज़िपकोड द्वारा अपराध डेटा एपीआई एक ज़िप कोड के लिए एक समग्र अपराध ग्रेड और हिंसक, संपत्ति, और अन्य अपराध श्रेणियों का विभाजन लौटाता है, साथ ही निकटवर्ती ज़िप की तुलना और समान-जनसंख्या वाले ज़िप। यह ऐप्स के लिए डिज़ाइन किया गया है जैसे कि रियल एस्टेट खोज, लॉजिस्टिक्स योजना, बीमा जोखिम स्क्रीनिंग, और स्थानीय डैशबोर्ड जहां ज़िप द्वारा त्वरित अपराध प्रोफ़ाइल की आवश्यकता होती है।
यह एपीआई ज़ाइला एपीआई हब पर उपलब्ध है, जो एक ऐसा मार्केटप्लेस है जिसमें एक खाते के तहत 10,000 से अधिक सार्वजनिक एपीआई हैं, एक एपीआई कुंजी, और एक सदस्यता मॉडल।
ज़ाइला एपीआई हब पर शुरुआत करना
इस एपीआई का उपयोग करने के लिए:
- ज़ाइला एपीआई हब पर एपीआई पृष्ठ खोलें और सदस्यता लें।
- डैशबोर्ड से अपनी एपीआई कुंजी कॉपी करें।
- Authorization: Bearer YOUR_API_KEY के साथ एंडपॉइंट को कॉल करें।
आप आइटम पृष्ठ पर 7-दिन की परीक्षण अवधि के साथ शुरू कर सकते हैं। वर्तमान पहुंच विकल्पों और मूल्य निर्धारण के लिए एपीआई पृष्ठ की जांच करें। बिलिंग सदस्यता + कोटा है, प्रति कॉल भुगतान नहीं।
ज़िपकोड द्वारा अपराध डेटा एपीआई पर 7-दिन की परीक्षण अवधि शुरू करें
एंडपॉइंट और अनुरोध
ज़िपकोड द्वारा अपराध डेटा एपीआई एक प्रमुख एंडपॉइंट को उजागर करता है जो एक ज़िप के लिए अपराध डेटा लाने के लिए है:
- ज़िप द्वारा अपराध दरें प्राप्त करें
- विधि: GET
- यूआरएल: https://zylalabs.com/api/824/crime-data-by-zipcode-api/583/get-crime-rates-by-zip
- आवश्यक क्वेरी पैरामीटर:
- zip (संख्या): विश्लेषण करने के लिए ज़िप कोड (उदाहरण: 01370)
आधिकारिक cURL उदाहरण
curl -s -X GET "https://zylalabs.com/api/824/crime-data-by-zipcode-api/583/get-crime-rates-by-zip?zip=01370" \
-H "Authorization: Bearer YOUR_API_KEY"
आधिकारिक नमूना प्रतिक्रिया
{"Overall":{"Zipcode":"01370","Overall Crime Grade":"B","Violent Crime Grade":"C-","Property Crime Grade":"B","Other Crime Grade":"B"},"Crime BreakDown":[{"Violent Crime Rates":{"Assault":"2.759","Robbery":"0.4627","Rape":"0.5506","Murder":"0.0218"},"0":{"Total Violent Crime":"3.795","Total Violent Crime Score":"(C-)"}},{"Property Crime Rates":{"Theft":"8.498","Vehicle Theft":"0.6988","Burglary":"1.563","Arson":"0.0619"},"0":{"Total Property Crime":"10.82","Total Property Crime Score":"(B)"}},{"Other Crime Rates":{"Kidnapping":"0.1303","Drug Crimes":"1.553","Vandalism":"3.749","Identity Theft":"0.4203","Animal Cruelty":"0.0490"},"0":{"Total Other Rate":"5.902","Total Other Score":"(B)"}}],"Crime Rates Nearby":[{"Nearby Zip":"01338, MA","Overall Crime Grade":"B-","Violent Crime Grade":"D","Property Crime Grade":"B-"},{"Nearby Zip":"01340, MA","Overall Crime Grade":"A-","Violent Crime Grade":"A-","Property Crime Grade":"B"},{"Nearby Zip":"01341, MA","Overall Crime Grade":"A","Violent Crime Grade":"C-","Property Crime Grade":"A"},{"Nearby Zip":"01301, MA","Overall Crime Grade":"C+","Violent Crime Grade":"C-","Property Crime Grade":"C"},{"Nearby Zip":"01330, MA","Overall Crime Grade":"A","Violent Crime Grade":"A-","Property Crime Grade":"A"},{"Nearby Zip":"01346, MA","Overall Crime Grade":"A","Violent Crime Grade":"C","Property Crime Grade":"A"},{"Nearby Zip":"01339, MA","Overall Crime Grade":"A","Violent Crime Grade":"C","Property Crime Grade":"A"},{"Nearby Zip":"01342, MA","Overall Crime Grade":"A","Violent Crime Grade":"B+","Property Crime Grade":"A+"},{"Nearby Zip":"01376, MA","Overall Crime Grade":"B-","Violent Crime Grade":"C+","Property Crime Grade":"B-"},{"Nearby Zip":"01337, MA","Overall Crime Grade":"A","Violent Crime Grade":"B-","Property Crime Grade":"A"}],"Similar Population Crime Rates":[{"Similar Zip":"34217, FL","Overall Crime Grade":"A-","Violent Crime Grade":"C+","Property Crime Grade":"C+"},{"Similar Zip":"72046, AR","Overall Crime Grade":"F","Violent Crime Grade":"D-","Property Crime Grade":"D-"},{"Similar Zip":"52778, IA","Overall Crime Grade":"B","Violent Crime Grade":"A-","Property Crime Grade":"A"},{"Similar Zip":"54126, WI","Overall Crime Grade":"A","Violent Crime Grade":"A+","Property Crime Grade":"A+"},{"Similar Zip":"02715, MA","Overall Crime Grade":"A+","Violent Crime Grade":"A-","Property Crime Grade":"A"},{"Similar Zip":"67025, KS","Overall Crime Grade":"B-","Violent Crime Grade":"B+","Property Crime Grade":"B+"},{"Sim…
आप आमतौर पर जो प्रमुख फ़ील्ड्स देखेंगे:
- Overall.Zipcode: क्वेरी का ज़िप कोड।
- Overall.Overall Crime Grade: एकल-लेटर ग्रेड (जैसे, B)।
- Overall.Violent Crime Grade, Property Crime Grade, Other Crime Grade: श्रेणी ग्रेड।
- Crime BreakDown: श्रेणी-विशिष्ट दरें और कुल (जैसे, Assault, Theft, Vandalism) और समग्र स्कोर।
- Crime Rates Nearby: निकटवर्ती ज़िप के साथ उनके ग्रेड की तुलना करने के लिए।
- Similar Population Crime Rates: समान जनसंख्या वाले ज़िप और उनके ग्रेड।
नोट्स:
- फ़ील्ड नामों में स्पेस शामिल हैं (जैसे, “Overall Crime Grade”)। JSON को पार्स करते समय, इन्हें जैसे हैं, ऐसे ही एक्सेस करें।
- संख्यात्मक दरों के लिए इकाइयाँ सेवा द्वारा प्रदान की गई जनसंख्या मेट्रिक्स हैं। इन्हें वापस लौटाए गए रूप में प्रदर्शित करें जब तक कि आप अपने UI में लगातार रूपांतरित न करें।
- यदि आपका कार्यभार बार-बार समान ज़िप को क्वेरी करता है, तो डुप्लिकेट कॉल और लेटेंसी को कम करने के लिए क्लाइंट-साइड कैशिंग जोड़ें।
पायथन उदाहरण: एक ज़िप लाएं और ग्रेड निकालें
यह नमूना एंडपॉइंट को कॉल करता है, समग्र और श्रेणी ग्रेड पढ़ता है, और निकटवर्ती ज़िप का सारांश देता है। YOUR_API_KEY को अपनी असली कुंजी से बदलें।
import os
import requests
API_KEY = os.getenv("Zyla_API_Key", "YOUR_API_KEY")
ZIP = "01370"
url = "https://zylalabs.com/api/824/crime-data-by-zipcode-api/583/get-crime-rates-by-zip"
params = {"zip": ZIP}
headers = {"Authorization": f"Bearer {API_KEY}"}
resp = requests.get(url, params=params, headers=headers, timeout=15)
resp.raise_for_status()
data = resp.json()
overall = data.get("Overall", {})
overall_grade = overall.get("Overall Crime Grade")
violent_grade = overall.get("Violent Crime Grade")
property_grade = overall.get("Property Crime Grade")
other_grade = overall.get("Other Crime Grade")
print(f"ZIP {overall.get('Zipcode')}: overall {overall_grade}, "
f"violent {violent_grade}, property {property_grade}, other {other_grade}")
# उदाहरण: यदि मौजूद हो तो Assault दर और Total Property Crime निकालें
breakdown = data.get("Crime BreakDown", [])
for section in breakdown:
if "Violent Crime Rates" in section:
assault = section["Violent Crime Rates"].get("Assault")
print(f"Assault rate: {assault}")
if "Property Crime Rates" in section:
total_prop = section.get("0", {}).get("Total Property Crime")
print(f"Total Property Crime: {total_prop}")
# निकटवर्ती ज़िप ग्रेड का पूर्वावलोकन
nearby = data.get("Crime Rates Nearby", [])
for n in nearby[:3]:
print(f"Nearby {n.get('Nearby Zip')}: overall {n.get('Overall Crime Grade')}")
समय बचाने वाले कार्यान्वयन विवरण
- प्रमाणीकरण: हर अनुरोध में Authorization: Bearer YOUR_API_KEY का उपयोग करें।
- त्रुटि हैंडलिंग: गैर-2xx प्रतिक्रियाओं को अस्थायी या अमान्य इनपुट के रूप में मानें (जैसे, गलत या असमर्थित ज़िप)। समस्या निवारण के लिए स्थिति कोड और प्रतिक्रिया शरीर को लॉग करें।
- टाइमआउट: एक क्लाइंट टाइमआउट सेट करें (10–15 सेकंड एक व्यावहारिक डिफ़ॉल्ट है) और नेटवर्क विफलताओं पर idempotent GETs को फिर से प्रयास करें।
- कैशिंग: अपने उपयोग के मामले की विंडो के लिए ज़िप द्वारा कैश करें (जैसे, घंटे से दिन)। बैकग्राउंड जॉब्स में stale-while-revalidate व्यवहार जोड़ें।
- UI टिप्स:
- ग्रेड अक्षर-आधारित हैं; अस्पष्टता से बचने के लिए एक किंवदंती प्रदान करें (जैसे, A सर्वश्रेष्ठ से F सबसे खराब)।
- जब श्रेणी के कुल दिखाते हैं (जैसे, “Total Property Crime”), यदि मौजूद हो तो श्रेणी स्कोर शामिल करें (जैसे, “(B)”)।
- संदर्भ के लिए, Crime Rates Nearby का उपयोग करके एक “निकटवर्ती ज़िप्स” तुलना दृश्य जोड़ें।
व्यावहारिक उपयोग के मामले जिन्हें आप अब भेज सकते हैं
- संपत्ति खोज: संपत्ति के ज़िप का उपयोग करके प्रत्येक लिस्टिंग कार्ड पर एक समग्र ग्रेड पिल दिखाएं; विस्तार दृश्य में श्रेणी विभाजन में विस्तार करें।
- स्थानांतरण उपकरण: एक चुने हुए ज़िप के लिए, ग्रेड और निकटवर्ती ज़िप लाएं ताकि सुरक्षित या तुलनीय पड़ोस की सिफारिश की जा सके।
- लास्ट-माइल संचालन: मार्ग योजना और डिलीवरी समय विंडो के लिए ज़िप द्वारा एक जोखिम स्कोर की गणना करें।
- किरायेदार स्क्रीनिंग पोर्टल: किराए के आवेदन में एक संदर्भ ज़िप जोखिम पैनल जोड़ें।
- बीमा पूर्व-उद्धरण: PII-भारी फॉर्म एकत्र करने से पहले स्थान जोखिम संकेत दिखाएं।
AI एजेंटों से MCP के साथ एपीआई कॉल करें
आप इस ही एंडपॉइंट को संगत AI एजेंटों और IDEs से ज़ाइला के मॉडल संदर्भ प्रोटोकॉल (MCP) गेटवे के माध्यम से बुला सकते हैं। MCP उपकरणों के लिए एपीआई एक्सेस को मानकीकृत करता है जैसे कि क्लॉड कोड, कर्सर, और विंडसर्फ। अपने क्लाइंट को MCP एंडपॉइंट पर पॉइंट करें, अपनी ज़ाइला एपीआई कुंजी के साथ अधिकृत करें, और उस उपकरण को कॉल करें जो ज़िप पैरामीटर के साथ ज़िपकोड द्वारा अपराध डेटा एपीआई यूआरएल पर GET जारी करता है।
दस्तावेज़ और कनेक्शन विवरण: MCP। वही Authorization: Bearer YOUR_API_KEY का उपयोग करें और ऊपर वर्णित अनुरोध यूआरएल और पैरामीटर को सटीक रूप से बनाए रखें।
ऑपरेशनल चेकलिस्ट
- इनपुट: ज़िप को 5-अंकीय संख्यात्मक स्ट्रिंग के रूप में मान्य करें; कॉल करने से पहले गैर-संख्यात्मक वर्णों को अस्वीकार या साफ करें।
- पर्यवेक्षण: सहायता डैशबोर्ड के लिए अनुरोध आईडी, ज़िप, स्थिति कोड, और न्यूनतम प्रतिक्रिया मेटाडेटा (जैसे, समग्र ग्रेड) लॉग करें।
- बैकऑफ: अस्थायी त्रुटियों या दर प्रतिक्रियाओं पर, गुणात्मक बैकऑफ और जिटर लागू करें; UI में एक फॉलबैक संदेश दिखाएं।
- सुरक्षा: एपीआई कुंजी को सर्वर-साइड रहस्यों में रखें; इसे कभी भी क्लाइंट-साइड कोड में उजागर न करें।
- डेटा ताज़ा करना: यदि आप समय-समय पर लोकप्रिय ज़िप को सिंक करते हैं, तो एक अनुसूचित कार्य चलाएं जो आपके कैश को गर्म करता है ताकि महसूस की गई लेटेंसी को कम किया जा सके।
एंड-टू-एंड फ्लो सारांश
- उपयोगकर्ता एक ज़िप का चयन करता है या आप इसे एक पते के जियोकोडर से अनुमान लगाते हैं।
- आपका बैकएंड GET https://zylalabs.com/api/824/crime-data-by-zipcode-api/583/get-crime-rates-by-zip को zip=XXXXX और Authorization: Bearer YOUR_API_KEY के साथ कॉल करता है।
- आपको आवश्यक JSON फ़ील्ड्स पार्स करें:
- शीर्ष स्तर UI के लिए समग्र ग्रेड।
- टूलटिप्स और विवरण पैनलों के लिए अपराध विभाजन।
- सिफारिशों के लिए निकटवर्ती ज़िप।
- ज़िप द्वारा कुंजीबद्ध प्रतिक्रिया को कैश करें; अपने कार्यक्रम पर समाप्त करें।
- अपने UI में ग्रेड और दरें प्रदर्शित करें; वैकल्पिक रूप से निकटवर्ती ज़िप की तुलना करने के लिए लिंक जोड़ें।
अक्सर पूछे जाने वाले प्रश्न
कौन सा पैरामीटर आवश्यक है?
क्वेरी स्ट्रिंग में ज़िप को एक संख्या के रूप में पास करें (उदाहरण: zip=01370)।
मैं प्रमाणीकरण कैसे करूं?
अनुरोध हेडर में Authorization: Bearer YOUR_API_KEY भेजें।
क्या मैं निकटवर्ती ज़िप की तुलना प्राप्त कर सकता हूं?
हाँ। प्रतिक्रिया में निकटवर्ती ज़िप और उनके ग्रेड के साथ अपराध दरें शामिल हैं।
मूल्य निर्धारण मॉडल क्या है?
ज़ाइला एपीआई सदस्यता + कोटा का उपयोग करते हैं। वर्तमान पहुंच विकल्पों के लिए एपीआई पृष्ठ की जांच करें; 7-दिन की परीक्षण अवधि आइटम पृष्ठ पर शुरू होती है।
क्या मैं इसे AI एजेंट से कॉल कर सकता हूं?
हाँ, संगत उपकरणों में ज़ाइला के MCP गेटवे के माध्यम से। वही Authorization हेडर और दस्तावेज़ित यूआरएल और ज़िप पैरामीटर का उपयोग करें।
एकीकृत करने के लिए तैयार हैं? ज़ाइला एपीआई हब पर अपना खाता बनाएं, अपनी एपीआई कुंजी प्राप्त करें, और यहां अपनी परीक्षण अवधि शुरू करें: ज़िपकोड द्वारा अपराध डेटा एपीआई। एक खाता, एक कुंजी, हजारों एपीआई जिन्हें आप इस सप्ताह भेज सकते हैं।
आधिकारिक एपीआई प्रतिक्रिया
{"Overall":{"Zipcode":"01370","Overall Crime Grade":"B","Violent Crime Grade":"C-","Property Crime Grade":"B","Other Crime Grade":"B"},"Crime BreakDown":[{"Violent Crime Rates":{"Assault":"2.759","Robbery":"0.4627","Rape":"0.5506","Murder":"0.0218"},"0":{"Total Violent Crime":"3.795","Total Violent Crime Score":"(C-)"}},{"Property Crime Rates":{"Theft":"8.498","Vehicle Theft":"0.6988","Burglary":"1.563","Arson":"0.0619"},"0":{"Total Property Crime":"10.82","Total Property Crime Score":"(B)"}},{"Other Crime Rates":{"Kidnapping":"0.1303","Drug Crimes":"1.553","Vandalism":"3.749","Identity Theft":"0.4203","Animal Cruelty":"0.0490"},"0":{"Total Other Rate":"5.902","Total Other Score":"(B)"}}],"Crime Rates Nearby":[{"Nearby Zip":"01338, MA","Overall Crime Grade":"B-","Violent Crime Grade":"D","Property Crime Grade":"B-"},{"Nearby Zip":"01340, MA","Overall Crime Grade":"A-","Violent Crime Grade":"A-","Property Crime Grade":"B"},{"Nearby Zip":"01341, MA","Overall Crime Grade":"A","Violent Crime Grade":"C-","Property Crime Grade":"A"},{"Nearby Zip":"01301, MA","Overall Crime Grade":"C+","Violent Crime Grade":"C-","Property Crime Grade":"C"},{"Nearby Zip":"01330, MA","Overall Crime Grade":"A","Violent Crime Grade":"A-","Property Crime Grade":"A"},{"Nearby Zip":"01346, MA","Overall Crime Grade":"A","Violent Crime Grade":"C","Property Crime Grade":"A"},{"Nearby Zip":"01339, MA","Overall Crime Grade":"A","Violent Crime Grade":"C","Property Crime Grade":"A"},{"Nearby Zip":"01342, MA","Overall Crime Grade":"A","Violent Crime Grade":"B+","Property Crime Grade":"A+"},{"Nearby Zip":"01376, MA","Overall Crime Grade":"B-","Violent Crime Grade":"C+","Property Crime Grade":"B-"},{"Nearby Zip":"01337, MA","Overall Crime Grade":"A","Violent Crime Grade":"B-","Property Crime Grade":"A"}],"Similar Population Crime Rates":[{"Similar Zip":"34217, FL","Overall Crime Grade":"A-","Violent Crime Grade":"C+","Property Crime Grade":"C+"},{"Similar Zip":"72046, AR","Overall Crime Grade":"F","Violent Crime Grade":"D-","Property Crime Grade":"D-"},{"Similar Zip":"52778, IA","Overall Crime Grade":"B","Violent Crime Grade":"A-","Property Crime Grade":"A"},{"Similar Zip":"54126, WI","Overall Crime Grade":"A","Violent Crime Grade":"A+","Property Crime Grade":"A+"},{"Similar Zip":"02715, MA","Overall Crime Grade":"A+","Violent Crime Grade":"A-","Property Crime Grade":"A"},{"Similar Zip":"67025, KS","Overall Crime Grade":"B-","Violent Crime Grade":"B+","Property Crime Grade":"B+"},{"Sim…
आधिकारिक एपीआई प्रतिक्रिया
{"Overall":{"Zipcode":"01370","Overall Crime Grade":"B","Violent Crime Grade":"C-","Property Crime Grade":"B","Other Crime Grade":"B"},"Crime BreakDown":[{"Violent Crime Rates":{"Assault":"2.759","Robbery":"0.4627","Rape":"0.5506","Murder":"0.0218"},"0":{"Total Violent Crime":"3.795","Total Violent Crime Score":"(C-)"}},{"Property Crime Rates":{"Theft":"8.498","Vehicle Theft":"0.6988","Burglary":"1.563","Arson":"0.0619"},"0":{"Total Property Crime":"10.82","Total Property Crime Score":"(B)"}},{"Other Crime Rates":{"Kidnapping":"0.1303","Drug Crimes":"1.553","Vandalism":"3.749","Identity Theft":"0.4203","Animal Cruelty":"0.0490"},"0":{"Total Other Rate":"5.902","Total Other Score":"(B)"}}],"Crime Rates Nearby":[{"Nearby Zip":"01338, MA","Overall Crime Grade":"B-","Violent Crime Grade":"D","Property Crime Grade":"B-"},{"Nearby Zip":"01340, MA","Overall Crime Grade":"A-","Violent Crime Grade":"A-","Property Crime Grade":"B"},{"Nearby Zip":"01341, MA","Overall Crime Grade":"A","Violent Crime Grade":"C-","Property Crime Grade":"A"},{"Nearby Zip":"01301, MA","Overall Crime Grade":"C+","Violent Crime Grade":"C-","Property Crime Grade":"C"},{"Nearby Zip":"01330, MA","Overall Crime Grade":"A","Violent Crime Grade":"A-","Property Crime Grade":"A"},{"Nearby Zip":"01346, MA","Overall Crime Grade":"A","Violent Crime Grade":"C","Property Crime Grade":"A"},{"Nearby Zip":"01339, MA","Overall Crime Grade":"A","Violent Crime Grade":"C","Property Crime Grade":"A"},{"Nearby Zip":"01342, MA","Overall Crime Grade":"A","Violent Crime Grade":"B+","Property Crime Grade":"A+"},{"Nearby Zip":"01376, MA","Overall Crime Grade":"B-","Violent Crime Grade":"C+","Property Crime Grade":"B-"},{"Nearby Zip":"01337, MA","Overall Crime Grade":"A","Violent Crime Grade":"B-","Property Crime Grade":"A"}],"Similar Population Crime Rates":[{"Similar Zip":"34217, FL","Overall Crime Grade":"A-","Violent Crime Grade":"C+","Property Crime Grade":"C+"},{"Similar Zip":"72046, AR","Overall Crime Grade":"F","Violent Crime Grade":"D-","Property Crime Grade":"D-"},{"Similar Zip":"52778, IA","Overall Crime Grade":"B","Violent Crime Grade":"A-","Property Crime Grade":"A"},{"Similar Zip":"54126, WI","Overall Crime Grade":"A","Violent Crime Grade":"A+","Property Crime Grade":"A+"},{"Similar Zip":"02715, MA","Overall Crime Grade":"A+","Violent Crime Grade":"A-","Property Crime Grade":"A"},{"Similar Zip":"67025, KS","Overall Crime Grade":"B-","Violent Crime Grade":"B+","Property Crime Grade":"B+"},{"Sim…