axprism 0.2.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- axprism/__init__.py +64 -0
- axprism/client.py +817 -0
- axprism/exceptions.py +45 -0
- axprism/models.py +357 -0
- axprism-0.2.0.dist-info/METADATA +188 -0
- axprism-0.2.0.dist-info/RECORD +9 -0
- axprism-0.2.0.dist-info/WHEEL +5 -0
- axprism-0.2.0.dist-info/licenses/LICENSE +21 -0
- axprism-0.2.0.dist-info/top_level.txt +1 -0
axprism/__init__.py
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
"""
|
|
2
|
+
AxPrism API client — institutional XBRL data and Shariah compliance screening.
|
|
3
|
+
|
|
4
|
+
Quick start::
|
|
5
|
+
|
|
6
|
+
pip install axprism
|
|
7
|
+
|
|
8
|
+
from axprism import AxPrism
|
|
9
|
+
|
|
10
|
+
client = AxPrism(api_key="axmd_live_...") # or the demo key below
|
|
11
|
+
|
|
12
|
+
# Screen a company for AAOIFI compliance
|
|
13
|
+
result = client.compliance("AAPL")
|
|
14
|
+
print(result.verdict) # "halal"
|
|
15
|
+
print(result.ratios.debt.ratio)
|
|
16
|
+
|
|
17
|
+
# Normalized financial statements
|
|
18
|
+
fin = client.financials("AAPL", statement="IS", period="annual")
|
|
19
|
+
print(fin.get_metric("Revenue"))
|
|
20
|
+
|
|
21
|
+
# International exchanges
|
|
22
|
+
client.tadawul.symbols(limit=10)
|
|
23
|
+
client.bursa.shariah()
|
|
24
|
+
|
|
25
|
+
A public, read-only demo key is available for testing:
|
|
26
|
+
``axmd_demo_try_axprism_2024``.
|
|
27
|
+
"""
|
|
28
|
+
|
|
29
|
+
__version__ = "0.2.0"
|
|
30
|
+
|
|
31
|
+
from .client import AxPrism
|
|
32
|
+
from .models import (
|
|
33
|
+
ComplianceResult,
|
|
34
|
+
EstimatesResult,
|
|
35
|
+
FinancialsResult,
|
|
36
|
+
PortfolioResult,
|
|
37
|
+
PriceHistory,
|
|
38
|
+
ProfileResult,
|
|
39
|
+
)
|
|
40
|
+
from .exceptions import (
|
|
41
|
+
AuthError,
|
|
42
|
+
AxPrismError,
|
|
43
|
+
BadRequestError,
|
|
44
|
+
NotFoundError,
|
|
45
|
+
RateLimitError,
|
|
46
|
+
TierError,
|
|
47
|
+
)
|
|
48
|
+
|
|
49
|
+
__all__ = [
|
|
50
|
+
"AxPrism",
|
|
51
|
+
"ComplianceResult",
|
|
52
|
+
"PortfolioResult",
|
|
53
|
+
"FinancialsResult",
|
|
54
|
+
"PriceHistory",
|
|
55
|
+
"EstimatesResult",
|
|
56
|
+
"ProfileResult",
|
|
57
|
+
"AxPrismError",
|
|
58
|
+
"AuthError",
|
|
59
|
+
"RateLimitError",
|
|
60
|
+
"TierError",
|
|
61
|
+
"NotFoundError",
|
|
62
|
+
"BadRequestError",
|
|
63
|
+
"__version__",
|
|
64
|
+
]
|