API Documentation

3min

Welcome to Quantfolio's API Documentation. This comprehensive guide is designed to help developers understand, integrate, and effectively utilize the DeepAlpha API in their applications. The API provides powerful tools for financial data analysis and investment decision-making, enabling users to harness the full potential of Quantfolio's robust platform.

Quantfolio is a leading provider of a Digital Investment Advice Solution, called DeepAlpha Advisory Platform (DAAP). The platform is specifically designed to empower financial advisors with the tools and resources they need to provide exceptional, compliant investment advice to their clients.

To ensure a smooth and successful integration, this documentation covers:

  1. Authentication: Learn how to authenticate your application and generate the necessary API keys for secure access to Quantfolio's services.
  2. Endpoints: Discover the various API endpoints available, along with detailed information on their purpose, input parameters, and expected response formats.
  3. Usage Guidelines: Understand the best practices for implementing the Quantfolio API, including error handling and pagination.

Before diving into the API integration, we recommend familiarizing yourself with DeepAlpha's core concepts and financial models to maximize the effectiveness of the tools at your disposal.

We are committed to providing exceptional support for our API users. If you have any questions or need assistance, please don't hesitate to reach out to our dedicated support team.

Happy coding, and we look forward to seeing the innovative solutions you'll create using the DeepAlpha API.

Environments

Quantfolio is committed to delivering a robust and reliable API experience to our external users. To ensure the highest levels of stability, security, and performance, we maintain two independent environments for our API: the QA (Quality Assurance) environment and the Production environment.

NB! Please note that the QA environment is not meant for real personal data as this is the environment that Quantfolio uses to ensure that the application works as expected for customer tenants during a release phase.

QA Environment: The QA environment serves as a testing ground for developers to integrate, test, and validate their applications with Quantfolio's API without affecting the production system. This environment mirrors the production environment in terms of features, endpoints, and functionality. However, it is important to note that during a release phase, the QA environment may contain updates or changes that have not yet been deployed to the production environment. This allows developers to test their applications against the latest updates and ensure compatibility before these changes are rolled out in production.

Base URL for QA Environment: https://api.qa.deepalpha.app

Production Environment: The Production environment is the live, fully-functional version of Quantfolio's Platform that developers use to access real-world financial data and analytics for their applications. This environment is subject to rigorous testing and validation to ensure the utmost reliability and stability. Developers should only use the Production environment for their finalized applications after thorough testing and validation in the QA environment.

Base URL for Production Environment: https://api.deepalpha.app

By maintaining separate QA and Production environments, Quantfolio ensures a secure and reliable API experience for all users. Developers can confidently test their applications without affecting real-world data or operations, while end users benefit from a stable and high-performing API that has undergone thorough testing and validation.

We encourage all developers to utilize the QA environment for their testing and integration needs before moving to the Production environment. This practice helps prevent potential issues and ensures seamless integration with DeepAlpha's API for your applications.

If you have any questions or feedback, contact our support teamο»Ώ

ο»Ώ

ο»Ώ

Updated 01 Jul 2024
Doc contributor
Doc contributor
Doc contributor
Doc contributor
Did this page help you?