ArthYugma · API Reference

HTTP API & webhooks for ArthYugma tools.

Integrate your own systems with ArthYugma for enquiries, account management and eventually order routing and telemetry.

JSON over HTTPS · REST styleBuilt for NSE / NFO workflows

Authentication

Auth cookies for dashboard; API keys / tokens for server‑side use.

Authorization: Bearer <token>

1. Enquiry API

Use the enquiry API to capture strategy briefs and project interest directly from your own site or tools, instead of sending users to the ArthYugma form.

POST/api/createUserQuery
Enquiry

Submit an enquiry for a custom strategy or integration.

Request example
POST /api/createUserQuery
Content-Type: application/json

{
  "name": "Rohan Sharma",
  "mobile": "9876543210",
  "preffered_lang": "Python",
  "segment": "NSE / NFO",
  "query": "BankNifty options intraday, 5 min, 2-leg spread",
  "need": "Backtest + live automation"
}
Response example
200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "Thank You for Interest"
}

2. Account API

Account endpoints are typically called from authenticated dashboards or secure backend services. They rely on the same session as your ArthYugma login or a token issued for your integration.

GET/api/getUserDetails
Account

Fetch profile information for the authenticated user.

Request
GET /api/getUserDetails
Cookie: arthyugma_session=...
Response (simplified)
200 OK

{
  "status": 200,
  "data": {
    "id": 42,
    "name": "Rohan Sharma",
    "email": "rohan@example.com",
    "username": "rohantrades",
    "mobile": "9876543210",
    "role": "User",
    "location": "Faridabad",
    "pincode": "121002"
  }
}
POST/api/updateUser
Account

Update profile, location and related metadata for a user.

Request
POST /api/updateUser
Content-Type: application/json
Cookie: arthyugma_session=...

{
  "name": "Rohan S",
  "location": "Faridabad",
  "address": "Sector 21C",
  "pincode": "121002",
  "profile_img": "/uploads/user-123.png"
}
Response
200 OK

{
  "status": 200,
  "message": "User updated successfully",
  "data": {
    "id": 42,
    "name": "Rohan S",
    "location": "Faridabad",
    "pincode": "121002",
    "profile_img": "/uploads/user-123.png",
    ...
  }
}

3. Webhooks (planned)

Webhooks will allow you to receive real‑time notifications when backtests complete, strategies change state, or orders are executed by Stock‑Exchanger.

Event types
  • backtest.completed
  • strategy.state_changed
  • order.executed
  • risk.limit_breached
Security

Webhook requests will be signed with a shared secret; verify the signature before trusting any payload in your systems.

If you want early access to the webhook spec, contact integrations@arthyugma.com.

Need a signed SLA or higher‑rate limits for your desk or platform? Reach out to discuss a dedicated integration.