# Ignite API

- [Ignite API](https://tickblaze.mintlify.app/index.md): Public API documentation for firm operations in Ignite.
- [URLs and credentials](https://tickblaze.mintlify.app/urls-and-credentials.md): Find the URLs, slug, and access details used during onboarding.
- [Quickstart](https://tickblaze.mintlify.app/quickstart.md): Authenticate with Ignite API and make your first request.
- [Configure your firm](https://tickblaze.mintlify.app/configure-your-firm.md): Understand what is usually configured during firm onboarding.
- [Account provisioning and entitlements](https://tickblaze.mintlify.app/account-provisioning-and-entitlements.md): Create users, create accounts, and activate required market data access.
- [Assign and revoke L2 data](https://tickblaze.mintlify.app/direct-l2-data-access.md): Grant or remove Level 2 market data for a user.
- [SQS integration](https://tickblaze.mintlify.app/sqs-integration.md): Receive optional queue messages for order, position, and account status events.
- [Deployment window](https://tickblaze.mintlify.app/deployment-window.md): When to expect routine Ignite API updates.
- [Changelog](https://tickblaze.mintlify.app/changelog.md): Product and API updates.
- [Create a trading account](https://tickblaze.mintlify.app/api-reference/accounts/create-a-trading-account.md): Create a new trading account for a user. Starting balance precedence is: explicit account `initial_balance`, then the selected Phase `initial_balance`, then the Challenge `initial_balance`. When `phase_id` is omitted or null, the account uses the first phase for `challenge_id`; provide `phase_id` to…
- [Retrieve trading account information](https://tickblaze.mintlify.app/api-reference/accounts/retrieve-trading-account-information.md): Returns information for a specific trading account. Account-level auto-liquidation data is unavailable: legacy fields are retained for compatibility and return null, and must not be interpreted as daily drawdown state.
- [Deactivate a trading account](https://tickblaze.mintlify.app/api-reference/accounts/deactivate-a-trading-account.md): Deactivate a trading account with a reason and, when requested, submit close-position requests for its open positions.
- [Reactivate a trading account](https://tickblaze.mintlify.app/api-reference/accounts/reactivate-a-trading-account.md): Reactivate a previously deactivated account with an optional balance reset.
- [Adjust balance for trading accounts](https://tickblaze.mintlify.app/api-reference/accounts/adjust-balance-for-trading-accounts.md): Adjust account balances in bulk. Supports add, subtract, and set operations for one or multiple accounts.
- [Get balance, equity and reporting fields for accounts](https://tickblaze.mintlify.app/api-reference/accounts/get-balance-equity-and-reporting-fields-for-accounts.md): Returns paginated accounts for end-of-day reporting. By default, returns only `ACTIVE` accounts. Pass `?status=FAILED`, another AccountStatusChoices value, or `?status=all` to broaden the result set. Combine with `?disabled_at_after=` and `?disabled_at_before=` to scope results to a window of when t…
- [List disabled trading accounts](https://tickblaze.mintlify.app/api-reference/accounts/list-disabled-trading-accounts.md): Returns currently disabled accounts. By default the endpoint returns accounts disabled within the rolling last 24 hours. Callers may pass `start_date` and `end_date` in `YYYY-MM-DD` to request an inclusive range up to 31 days.
- [Bulk reactivate trading accounts](https://tickblaze.mintlify.app/api-reference/accounts/bulk-reactivate-trading-accounts.md): Reactivate failed accounts so their traders can resume trading. Each account in `account_ids` returns to ACTIVE and its failure reason is cleared. Accounts that aren't currently failed are reported under `skipped` instead of rejecting the whole request, so retries are safe. Set `reset_balance` to re…
- [Update trading account statuses](https://tickblaze.mintlify.app/api-reference/accounts/update-trading-account-statuses.md): Updates the account status for every account in `account_ids` and stores the optional `custom_status_reason`. Returns a payload summarizing how many account statuses changed.
- [List accounts with optional field selection and nested objects](https://tickblaze.mintlify.app/api-reference/accounts/list-accounts-with-optional-field-selection-and-nested-objects.md): Returns paginated accounts with optional field selection through `query`. Callers can request account fields, `user` and `phase` objects, position counts, and up to 10 recent closed positions per account. `status` filters accounts and defaults to `ACTIVE`; use `all` to disable that filter. `position…
- [List Challenges](https://tickblaze.mintlify.app/api-reference/challenge/list-challenges.md): Returns a paginated list of Challenges for your firm, including nested phases, allowed exchange limits, and individual symbol limits.
- [List user entitlements](https://tickblaze.mintlify.app/api-reference/entitlements/list-user-entitlements.md): Returns a paginated list of user entitlement records for users associated with your firm. Each record includes the overall entitlement status and your firm's status for that entitlement, when available.
- [Retrieve user entitlements by user_id](https://tickblaze.mintlify.app/api-reference/entitlements/retrieve-user-entitlements-by-user_id.md): Returns entitlement records for the requested `user_id` when the user is associated with your firm. Each record includes the overall entitlement status and your firm's status for that entitlement, when available.
- [Authorize or revoke user entitlements](https://tickblaze.mintlify.app/api-reference/entitlements/authorize-or-revoke-user-entitlements.md): Update your firm's entitlement status for the requested user and entitlement package. L2 market data access may be created directly. L1 access can be updated only when the user already has L1 eligibility. Call `PATCH /api/users/{user_id}/entitlements/` using the `user_id` value returned by `GET /api…
- [Health probe](https://tickblaze.mintlify.app/api-reference/status/health-probe.md): Returns liveness information for infrastructure monitors.
- [Scheduled outage status](https://tickblaze.mintlify.app/api-reference/status/scheduled-outage-status.md): Returns the current platform outage state. `ok` means no outage is reported. `scheduled_outage` is returned during the daily 17:00–18:00 America/New_York maintenance window. `unscheduled_outage` is reserved for unplanned outage reporting.
- [Submit close requests for all open positions for an account](https://tickblaze.mintlify.app/api-reference/trade/submit-close-requests-for-all-open-positions-for-an-account.md): Submits close requests for each open symbol exposure on the specified account. Staff users can operate on any account for the authenticated firm, while non-staff users are limited to their own accounts. The response reports submitted and failed symbol requests; a 200 response does not guarantee ever…
- [Submit close requests for all open positions for an account](https://tickblaze.mintlify.app/api-reference/trade/submit-close-requests-for-all-open-positions-for-an-account-1.md): Submits close requests for each open symbol exposure on the specified account. Staff users can operate on any account for the authenticated firm, while non-staff users are limited to their own accounts. The response reports submitted and failed symbol requests; a 200 response does not guarantee ever…
- [List positions across accessible accounts](https://tickblaze.mintlify.app/api-reference/trade/list-positions-across-accessible-accounts.md): Returns positions for trading accounts the caller can access, filtered by state. Staff users can see every account in the firm, while non-staff users only see their own accounts.
- [Submit a close request for one account and symbol](https://tickblaze.mintlify.app/api-reference/trade/submit-a-close-request-for-one-account-and-symbol.md): Submits a close request for the specified account and symbol. Staff users can operate on any position for the authenticated firm, while non-staff users are limited to their own accounts. `triggered_by` is optional and defaults to authenticated user metadata when omitted.
- [List users](https://tickblaze.mintlify.app/api-reference/users/list-users.md): Returns paginated users for your firm, including account counts.
- [Create a trader user](https://tickblaze.mintlify.app/api-reference/users/create-a-trader-user.md): Create a trader user for your firm. The user can access only the trader dashboard and cannot access admin-only endpoints. If the email already belongs to an existing user, that user is granted access for your firm and the submitted password is ignored. Use `results[].existing_user` to decide whether…
- [Retrieve user details](https://tickblaze.mintlify.app/api-reference/users/retrieve-user-details.md): Returns a single user with annotated account counts.
- [Update user contact details](https://tickblaze.mintlify.app/api-reference/users/update-user-contact-details.md): Allows authorized callers to update supported user profile/contact fields and KYC verification status. Use deactivate/reactivate endpoints to manage user access.
- [Get per-user account counts](https://tickblaze.mintlify.app/api-reference/users/get-per-user-account-counts.md): Returns purchased, active and failed account totals for the user, aggregated across duplicate accounts in the same group. Cached for 5 minutes.
- [Deactivate a user](https://tickblaze.mintlify.app/api-reference/users/deactivate-a-user.md): Deactivate a user with an audit reason. By default, the user's trading accounts for your firm are also blocked. Set `deactivate_accounts=false` to leave trading accounts unchanged.
- [Get user entitlements by token](https://tickblaze.mintlify.app/api-reference/users/get-user-entitlements-by-token.md): Accepts a token key in the path (`/api/users/{token}/entitlements/`), resolves the token owner, and returns data entitlements for that user if eligible.
- [Reactivate a user](https://tickblaze.mintlify.app/api-reference/users/reactivate-a-user.md): Restore access for a previously deactivated user. This endpoint reactivates only the user profile and does not change trading accounts.
- [List entitlement flags by user](https://tickblaze.mintlify.app/api-reference/users/list-entitlement-flags-by-user.md): Returns a paginated per-user entitlement snapshot. Each user item includes every entitlement key; `true` means the user has at least one authorized entitlement that enables trading for that entitlement.
- [Export users CSV](https://tickblaze.mintlify.app/api-reference/users/export-users-csv.md): Exports every user matching the same filters, search, sorting, permissions, and firm scope used by the users list. The CSV mirrors the users-list response fields except user-deduplication duplicate-group details.
- [List withdrawals](https://tickblaze.mintlify.app/api-reference/withdrawals/list-withdrawals.md): List your firm's withdrawals from the last 365 days, with optional filtering by payout month, account ID, or both.
- [Check potential withdrawal details](https://tickblaze.mintlify.app/api-reference/withdrawals/check-potential-withdrawal-details.md): Return estimated payout details and the next withdrawal date for a user's account.
- [Request a withdrawal](https://tickblaze.mintlify.app/api-reference/withdrawals/request-a-withdrawal.md): Submit a withdrawal request for the requested account. When accepted, the account is blocked from trading.
- [Authenticate a user](https://tickblaze.mintlify.app/api-reference/auth/authenticate-a-user.md): Authenticates a user with an email address and password.
- [Refresh access token](https://tickblaze.mintlify.app/api-reference/auth/refresh-access-token.md): Rotates a refresh token and returns a new firm-bound session access token. Rotation is bound to the submitted refresh token's Prop Firm and does not require callers to use that firm's request host.

## OpenAPI Specs

- [ignite-public-openapi](/ignite-public-openapi.json)
- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.