API Information

The IS-Macro Engine API provides streamlined access to a comprehensive suite of macroeconomic data and calculation tools for fixed income instruments. Our API facilitates efficient data analysis and integration, empowering financial experts with real-time insights for strategic market decisions.

API Documentation

For a detailed and interactive overview of our API endpoints, visit our SwaggerUI Documentation. If you prefer a more static documentation format, check out our ReDoc Documentation.

You can also access our API schema directly at OpenAPI JSON.

Authentication Guide

To ensure secure access to the API, we employ token-based authentication. Follow these steps to authenticate and start using the API:

  1. Obtaining Your Access Token

    Send a POST request to /api/auth/token with your username and password as form data.

    POST /api/auth/token
    Content-Type: application/x-www-form-urlencoded
    
    username=YOUR_USERNAME&password=YOUR_PASSWORD

    Upon successful authentication, the server will respond with a JSON object containing your access_token and the token type (typically "bearer").

  2. Using Your Access Token

    To access protected routes, include this token in the Authorization header of your HTTP requests. The header should be formatted as follows:

    Authorization: Bearer YOUR_ACCESS_TOKEN
  3. Token Expiry

    Note that tokens are valid for a limited time (30 minutes by default). After the token expires, you will need to authenticate again to receive a new token.

  4. Handling Authentication Errors

    If you encounter a 401 Unauthorized error, ensure your username and password are correct and that your token has not expired.

Need Help?

If you have any questions or need support, please contact us at lce@lce.is.