Services
    • Introduction
    • API Reference
      • Funds
        • Fund Performance
    • Schemas
      • Public
        • Errors
        • ApiError
        • Perfomance Metrics
        • Returns by Period

    Introduction

    Alphaledger Services API#

    Overview#

    The Alphaledger Services API provides programmatic access to Alphaledger's platform for managing securities, ratings, accounting operations, and fund data. This RESTful API enables integration partners and clients to automate workflows and synchronize data with the Alphaledger ecosystem.

    Base URL#

    All API endpoints are relative to:
    https://services.alphaledger.com/api/v1
    For development and testing:
    http://localhost:3000/api/v1

    Key Features#

    Moody's Ratings Management: Create and update agency credit ratings with automatic blockchain synchronization
    Accounting Operations: Execute buy (subscription) and sell (redemption) transactions
    Fund Price Data: Retrieve real-time fund pricing information
    OAuth Authentication: Secure token-based authentication

    API Versioning#

    The API uses URL-based versioning. The current version is v1, included in the base path (/api/v1).

    Request Format#

    All requests must use HTTPS in production
    Request bodies must be JSON with Content-Type: application/json
    All dates must be in ISO8601 format (e.g., 2025-03-26T00:00:00Z)

    Response Format#

    All responses are returned in JSON format with the following structure:

    Success Response#

    {
      "data": { ... },
      "timestamp": "2025-03-26T10:30:00.000Z"
    }

    Error Response#

    {
      "statusCode": 400,
      "message": "Validation failed",
      "error": "Bad Request"
    }

    HTTP Status Codes#

    Status CodeDescription
    200Success - Request completed successfully
    400Bad Request - Invalid request parameters or validation error
    401Unauthorized - Missing or invalid authentication token
    404Not Found - Resource does not exist
    500Internal Server Error - Server-side error

    Rate Limiting#

    API requests are subject to rate limiting. Current limits:
    Standard tier: 100 requests per minute
    Premium tier: 1000 requests per minute
    Rate limit headers are included in all responses:
    X-RateLimit-Limit: 100
    X-RateLimit-Remaining: 95
    X-RateLimit-Reset: 1679836800

    Pagination#

    List endpoints support pagination using cursor-based pagination:
    GET /api/v1/resources?limit=50&cursor=abc123

    Support#

    For API support and questions:
    Email: api-support@alphaledger.com
    Documentation: https://docs.alphaledger.com
    Modified at 2026-01-08 16:34:33
    Next
    Fund Performance
    Built with