इस प्रोजेक्ट के बारे में

Alpaca-py, Alpaca के वित्तीय API उत्पादों के साथ एप्लिकेशन को एकीकृत करने के लिए आधिकारिक Python SDK है। यह Alpaca के Broker, Trading और Market Data API के लिए टाइप्ड क्लाइंट प्रदान करता है और REST, WebSocket तथा SSE-आधारित एक्सेस पैटर्न को कवर करता है। इस पैकेज के लिए Python 3.10 या उससे नया संस्करण आवश्यक है और इसे pip के साथ इंस्टॉल किया जा सकता है। SDK एकल सामान्य इंटरफ़ेस के बजाय अलग-अलग क्लाइंट क्लासेस के आसपास संगठित है। BrokerClient, ब्रोकरेज वर्कफ़्लो का समर्थन करता है, जैसे कि प्रबंधित खातों की सूची बनाना और फ़िल्टर करना। TradingClient, टाइप्ड रिक्वेस्ट मॉडल का उपयोग करके ऑर्डर सबमिट और प्रबंधित करता है, जिनमें मार्केट, लिमिट, स्टॉप और ट्रेलिंग-स्टॉप ऑर्डर शामिल हैं। मार्केट-डेटा क्लाइंट्स में StockHistoricalDataClient, CryptoHistoricalDataClient, OptionHistoricalDataClient, NewsClient और स्टॉक्स, क्रिप्टो, ऑप्शंस तथा न्यूज़ के लिए संबंधित स्ट्रीमिंग क्लासेस शामिल हैं। रिक्वेस्ट्स एक ऑब्जेक्ट-ओरिएंटेड डिज़ाइन का उपयोग करती हैं जिसमें मेथड पैरामीटर समर्पित रिक्वेस्ट मॉडल द्वारा दर्शाए जाते हैं, जैसे MarketOrderRequest, CryptoBarsRequest और ListAccountsRequest। मॉडल्स को रनटाइम पर pydantic के साथ मान्य किया जाता है और इन्हें डिक्शनरीज़ से भी बनाया जा सकता है, जो किसी अन्य एप्लिकेशन से प्राप्त JSON को मान्य करने में सहायक हो सकता है। ऐतिहासिक डेटा प्रतिक्रियाओं को प्रदान की गई .df प्रॉपर्टी के माध्यम से pandas DataFrames में परिवर्तित किया जा सकता है। दस्तावेज़ीकरण के अनुसार, मार्केट-डेटा API स्टॉक्स, क्रिप्टो और ऑप्शंस के लिए लाइव और ऐतिहासिक डेटा तक पहुंच प्रदान करता है, जबकि ट्रेडिंग API स्टॉक और क्रिप्टो ऑर्डर निष्पादन का समर्थन करता है। Broker API और Connect का उद्देश्य निवेश एप्लिकेशन बनाना है, जैसे रोबो-एडवाइज़र या ब्रोकरेज उत्पाद। Alpaca पेपर/सैंडबॉक्स वातावरण और ट्रेडिंग/मार्केट-डेटा तथा ब्रोकर उपयोग के लिए अलग API कुंजियाँ प्रदान करता है। रिपॉज़िटरी में ब्रोकरेज खाता सूचीबद्ध करने, ऑर्डर सबमिट करने, ऐतिहासिक क्रिप्टो बार्स, न्यूज़ क्वेरीज़, ऑप्शंस ट्रेडिंग के उपयोग उदाहरण और स्टॉक्स, क्रिप्टो, ऑप्शंस तथा मल्टी-लेग ऑप्शंस के लिए Jupyter नोटबुक्स शामिल हैं। दस्तावेज़ीकरण क्लाइंट्स, मेथड्स, मॉडल्स और शुरुआत करने के उदाहरणों को कवर करता है।