Getting Started
Welcome to the Arys Consultancy API! Our RESTful API allows you to integrate enterprise-grade financial AI into your institutional systems and workflows.
Base URL
https://api.arys.in/v1
Quick Start
Get your financial AI platform running in minutes:
- Sign up for an Arys Consultancy enterprise account
- Generate an API key from your institutional dashboard
- Configure your first AI model or analysis workflow
- Deploy and monitor your financial AI solutions
Authentication
Arys Consultancy uses enterprise-grade API keys for authentication. Include your API key in the Authorization header:
curl -H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
https://api.arys.in/v1/trading/analysis
API Key Management
- Generate: Create new API keys in your enterprise dashboard
- Rotate: Regularly rotate keys for enhanced security
- Scope: Limit key permissions by product suite and resource type
- Monitor: Track API key usage, rate limits, and security events
Trading Intelligence API
Access our flagship trading AI models for market analysis, prediction, and algorithmic trading.
FX Analysis
POST /v1/trading/fx/analysis
{
"currency_pairs": ["EURUSD", "GBPUSD", "USDJPY"],
"analysis_type": "trend_prediction",
"time_horizon": "1d",
"include_sentiment": true,
"model": "fxchai_v2"
}
Equity Pulse Analysis
GET /v1/trading/equity/pulse?symbols=AAPL,GOOGL,MSFT
Response:
{
"analysis": [
{
"symbol": "AAPL",
"trend_score": 0.78,
"momentum": "bullish",
"sector_rotation_signal": "hold",
"earnings_surprise_probability": 0.65,
"technical_patterns": ["ascending_triangle", "volume_breakout"]
}
],
"generated_at": "2025-01-11T10:30:00Z"
}
Options Flow Analysis
POST /v1/trading/options/flow
{
"underlying": "SPY",
"date_range": {
"start": "2025-01-01",
"end": "2025-01-11"
},
"min_volume": 1000,
"unusual_activity_threshold": 2.0
}
Risk & Compliance API
Comprehensive risk assessment and regulatory compliance automation.
Credit Risk Assessment
POST /v1/risk/credit/assess
{
"entity_id": "CORP_12345",
"financial_data": {
"revenue": 1000000000,
"debt_to_equity": 0.45,
"current_ratio": 1.8,
"interest_coverage": 5.2
},
"industry": "technology",
"geography": "US"
}
AML Screening
POST /v1/compliance/aml/screen
{
"transaction": {
"amount": 50000,
"currency": "USD",
"from_account": "ACC_001",
"to_account": "ACC_002",
"description": "Business payment"
},
"parties": [
{
"name": "John Doe",
"type": "individual",
"country": "US"
}
]
}
Stress Testing
POST /v1/risk/stress-test
{
"portfolio": {
"positions": [
{"symbol": "AAPL", "quantity": 1000, "price": 150},
{"symbol": "GOOGL", "quantity": 500, "price": 2800}
]
},
"scenarios": ["market_crash_2008", "covid_2020", "custom_scenario"],
"confidence_levels": [0.95, 0.99],
"time_horizon": "1y"
}
Portfolio Management API
AI-driven portfolio optimization and wealth management solutions.
Portfolio Optimization
POST /v1/portfolio/optimize
{
"universe": ["AAPL", "GOOGL", "MSFT", "TSLA", "NVDA"],
"constraints": {
"max_weight": 0.3,
"min_weight": 0.05,
"sector_limits": {
"technology": 0.6
}
},
"objective": "max_sharpe",
"risk_model": "factor_model_v3",
"rebalance_frequency": "monthly"
}
ESG Scoring
GET /v1/portfolio/esg/score?symbols=AAPL,MSFT,GOOGL
Response:
{
"scores": [
{
"symbol": "AAPL",
"esg_score": 82,
"environmental": 85,
"social": 78,
"governance": 84,
"sustainability_rank": "A",
"last_updated": "2025-01-10T00:00:00Z"
}
]
}
Webhooks
Receive real-time notifications about market events, risk alerts, and system status changes.
Webhook Events
- market.alert: Significant market movement or anomaly detected
- risk.threshold_breach: Risk metric exceeded predefined limits
- compliance.violation: Potential compliance issue identified
- portfolio.rebalance: Portfolio rebalancing recommendation generated
- system.maintenance: Scheduled maintenance or system updates
Webhook Payload
{
"event": "risk.threshold_breach",
"timestamp": "2025-01-11T10:30:00Z",
"data": {
"portfolio_id": "PORT_12345",
"metric": "var_95",
"current_value": 0.052,
"threshold": 0.05,
"severity": "medium",
"recommendation": "reduce_equity_exposure"
}
}
SDKs and Libraries
Use our official SDKs to integrate Arys Consultancy into your financial applications.
Python SDK
pip install arys-financial-ai
from arys import ArysClient
client = ArysClient(api_key="your_key")
analysis = client.trading.fx_analysis(
pairs=["EURUSD", "GBPUSD"],
model="fxchai_v2"
)
Node.js SDK
npm install @arys/financial-ai-sdk
const { ArysClient } = require('@arys/financial-ai-sdk');
const client = new ArysClient({
apiKey: 'your_key'
});
const portfolio = await client.portfolio.optimize({
universe: ['AAPL', 'GOOGL', 'MSFT'],
objective: 'max_sharpe'
});
Available SDKs
- Python: Full-featured SDK with async support and financial data types
- Node.js: TypeScript definitions and enterprise integrations
- Java: Enterprise-ready with Spring Boot and Maven support
- C#/.NET: Windows and Azure integration capabilities
- R: Statistical computing and quantitative analysis support
- REST API: Direct HTTP calls for any programming language
Enterprise Features
Rate Limits
API rate limits by enterprise plan:
- Enterprise Starter: 10,000 requests/hour
- Growth: 100,000 requests/hour
- Strategic Partnership: Custom limits and dedicated infrastructure
Data Residency & Compliance
- Regional Deployment: Choose data processing regions
- Compliance: SOC 2, ISO 27001, GDPR, and financial regulations
- Audit Logs: Comprehensive API usage and data access logs
- Encryption: End-to-end encryption for all API communications
Error Handling
The API uses conventional HTTP response codes:
- 200: Success - Request completed successfully
- 400: Bad Request - Invalid parameters or request format
- 401: Unauthorized - Invalid or missing API key
- 403: Forbidden - Insufficient permissions for resource
- 429: Too Many Requests - Rate limit exceeded
- 500: Internal Server Error - System error occurred
Support & Resources
Need Technical Support?
Our developer support team is available to help with integration challenges and technical questions.