canonical: https://jentic.com/apis/magick.nu/tradeworks

# Magick Nu Tradeworks

The Tradeworks API manages users and trading accounts for an algorithmic trading platform. It creates users, checks whether a username or email is available, updates a user's password, adds MT4 trading accounts and updates their passwords, and lists template strategies and retrieves a strategy by its ID. Responses are JSON, so an agent can provision a user, connect a trading account, or fetch a strategy template without a custom back end.

## For AI agents

Create users, check username and email availability, manage passwords, add MT4 trading accounts, and read strategies.

## Scope

Manages users, MT4 trading accounts, and strategy templates through Tradeworks; it does not place trades, stream market data, or run strategies, which live in the trading platform.

## Capabilities

- Create a user account
- Check whether a username or email is available
- Update a user's password
- Add an MT4 trading account
- Update an MT4 trading account password
- List template strategies and read a strategy by ID

## Use cases

### Provision a user

Onboarding a trader starts with creating their account. The Tradeworks API creates a user and checks whether a chosen username or email is available, so an application can register a trader cleanly. Availability checks let the signup flow catch conflicts before submitting.

Example prompt: Check username availability, then create the user.

### Connect a trading account

Trading needs a linked brokerage account. The Tradeworks API adds an MT4 trading account and updates its password, so an application can connect and maintain the account a trader uses. Keeping the account password current preserves the connection.

Example prompt: Add the MT4 trading account for the user.

### Read strategy templates

Building on prebuilt strategies saves setup time. The Tradeworks API lists template strategies and retrieves a strategy by its ID, so an application can present starting points a trader can adopt. A single strategy can be fetched for detail before it is used.

Example prompt: List the template strategies and return the requested one.

### Agent-driven account setup

An AI agent can register a trader and connect an account without a developer wiring each call. Through Jentic the agent matches an intent such as 'create an account for this trader' to the Tradeworks user operation, runs it, and continues with the trading account. The credential stays in the user's Jentic One instance and never reaches the agent's prompt.

Example prompt: Create the user and add their MT4 trading account.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/users` | Create a new Tradeworks user. |
| GET | `/users/username/{username}` | Check whether a username is available. |
| GET | `/users/email/{email}` | Check whether an email is available. |
| POST | `/tradingAccounts` | Add a trading account. |
| GET | `/strategies/templates` | List all template strategies. |
| GET | `/strategies/strategyId/{strategyId}` | Get a strategy by its ID. |

## Key resources

- **Users** — Create users and check username and email availability.
- **Trading accounts** — Add MT4 accounts and update their passwords.
- **Strategies** — List template strategies and read a strategy by ID.

## Why Jentic

- **Setup:** Wiring Tradeworks yourself means handling its username and password credential, provisioning users, and connecting MT4 accounts. With Jentic you install once, import Tradeworks from the API Directory, and store the credential a single time.
- **Permission scoping:** Jentic lets you grant your agent only the operations it needs, such as creating users and reading strategies without password changes, and enforces that on every call.
- **Credential handling:** Your Tradeworks credential is stored once, encrypted, by your own Jentic One instance. It is injected when a call runs and never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents find Tradeworks through Jentic's intent search, matching a request like 'create a trading user' to the right operation without hardcoded endpoints.

## Related APIs

- **Tradier** — Brokerage and trading API for equities and options.
- **Finnhub** — Real-time market data and fundamentals.
- **Alpha Vantage** — Historical and real-time market data.

## FAQ

### What can an AI agent do with the Tradeworks API through Jentic?

An agent can create users, check username and email availability, manage passwords, add MT4 trading accounts, and read strategies. Through Jentic the agent matches an intent to the right operation and runs it with your credential injected at execution time.

### How do I authenticate with the Tradeworks API?

The specification does not declare a formal security scheme, and the API's documentation states that a username and password are needed to call its methods. You store that credential once in your Jentic One instance, and it is added to each call at run time rather than exposed to the agent.

### Does Tradeworks support MT4 trading accounts?

Yes. The API adds MT4 trading accounts and updates their passwords, so an application can connect and maintain the account a trader uses. Keeping the password current preserves the account connection.

### Does the Tradeworks API document rate limits?

The OpenAPI specification does not state rate limits. Check Tradeworks' own documentation for any request allowances that apply to your account.

### Can I control which Tradeworks operations my agent can call?

Yes. Jentic lets you allow only the operations your agent needs, for example creating users and reading strategies while withholding password changes. Your Jentic One instance enforces that boundary on every call and keeps the credential outside the agent's context.