# API

The ProjectX API is a powerful tool that allows traders and developers to automate, integrate, and customize their trading experience on the ProjectX platform. Whether you're building custom trading strategies, managing risk, or connecting third-party tools, the API provides the flexibility and capability you need.

#### Key Benefits and Features

* **Automate Your Trading:** Set up automated trade execution, reducing manual tasks and improving efficiency.
* **Build Custom Solutions:** Create your own trading tools, dashboards, and workflows tailored to your needs.
* **Test and Validate Strategies:** Use real-time and historical data to test and refine your strategies.
* **Developer Friendly:** Supports multiple programming languages including Python, Java, .NET, and more.
* **Risk Management Tools:** Build custom alerts, lockouts, and limits to align with your trading risk profile.
* **Real-Time Market Data:** Stream market data directly into your applications for faster decision-making.
* **Third-Party Integration:** Connect seamlessly with external tools, analytics platforms, and other software.

#### How to Access the ProjectX API

To access the API, you’ll need an active API subscription. This subscription provides access across all ProjectX environments. You only need one subscription across all ProjectX environments, no matter where you trade.

You can manage your API subscription and linked accounts through the ProjectX Dashboard.

#### Who is it for?

The ProjectX API is ideal for:

* Individual traders with Websocket and REST API experience looking to automate or enhance their trading process.
* Developers building trading tools or risk management solutions.

## How to Get Started with the ProjectX Dashboard & API Access

**1.** You can access the ProjectX Dashboard in two ways:

* From inside the trading platform:
  * Go to **Settings → API**
  * Click **“Link”** under **ProjectX Linking**
* Or directly visit: [dashboard.projectx.com](http://dashboard.projectx.com)

2. On the ProjectX Dashboard homepage, click **“Register”** in the top right corner to create your ProjectX Dashboard user.
   * You can use a different email and username than your trading platform login OR the same.
   * This is a separate, centralized user for managing API access and subscriptions via ProjectX.
3. After registering, log in with your new ProjectX Dashboard credentials.

   When you log in, you’ll be taken to the **Dashboard Home page**.
4. To activate API access:

   * Navigate to **“Subscriptions”** in the left-hand menu.
   * Select your plan and complete the subscription purchase.

   This subscription is required to enable API access across all ProjectX environments.
5. Once subscribed:

   * Go back to the Platform Settings **→ API**
   * **Click “Link”** under **ProjectX Linking**
   * From the ProjectX Link Account Dashboard page, you can now link your active account<br>

   You’re now set up! API access is enabled across all linked accounts. You can not retrieve your API key from the Platform Settings **→ API → API Key** and follow the [documentation](https://gateway.docs.projectx.com/) to authenticate.\ <br>

   <figure><img src="/files/TvFWeJVlNgP6MgmQJ9SU" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.topstepx.com/settings/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.