# PropFirmConnector Vendor API

> Rithmic futures prop firms and NinjaTrader vendors can offer PropFirmConnector to their traders. PropFirmConnector is an independent NinjaTrader 8 addon for Rithmic accounts. There are two API integrations, the License API and the Coupon API, plus an affiliate program that needs no API.

This index covers the public Vendor API documentation. API access requires vendor onboarding and a server-side credential. The approved vendor configuration determines the integration model and permissions; publishing a guide does not enable access. Commercial terms are agreed separately.

The licensing model supports approved monthly/lifetime resale access or sponsored access. Resale requests require a plan; sponsored requests must omit it. Monthly and sponsored access remain enabled until explicitly disabled. Lifetime access, when approved, is permanent and cannot be disabled or downgraded through the API. These are addon licenses, not trading-account credentials, market data, or brokerage execution APIs.

## Why partners offer PropFirmConnector

- Prop firms: traders who use NinjaTrader 8 can trade the firm's Rithmic accounts even when NinjaTrader has no native connection for them. The firm builds nothing into its platform; traders log in with the Rithmic credentials the firm already issues, and can run several accounts at once in one NinjaTrader window.
- NinjaTrader vendors: their indicators, strategies and trade copiers reach traders whose Rithmic prop firm accounts NinjaTrader cannot connect on its own. Trade copier customers can run several Rithmic logins at once, which NinjaTrader alone does not allow. Customers get a discount and the vendor earns a markup or a revenue share.

## License API, Coupon API or affiliate program

Three ways for a prop firm or vendor to offer PropFirmConnector. They differ in who bills the trader and how the partner earns. License pricing and coupon discounts are agreed with each partner; contact PropFirmConnector for details.

- License API: the partner buys licenses from PropFirmConnector at discounted license pricing, invoiced monthly, and its server issues each license. The trader buys and downloads on the partner's website and never sees a PropFirmConnector checkout. The partner sets the trader's price: include it free, pass the cost on, or charge more and keep the margin. No revenue share is paid.
- Coupon API: the partner's server requests a single-use discount code and shows it to the trader, who uses it to buy a license from PropFirmConnector directly. PropFirmConnector takes payment, activates the license and bills renewals. The partner is never invoiced and sends no customer identity. The whole discount goes to the trader; no revenue share is paid. The API and optional signed webhooks report whether each code was redeemed and the status of the license it bought.
- Affiliate program (no API): the partner shares an affiliate link and coupon, its customers buy from PropFirmConnector at the affiliate coupon discount, and the partner earns a revenue share on each referred customer. Details: https://propfirmconnector.com/affiliate-program/
- A partner can hold both API permissions on one vendor account.

## Start here

- [Prop firm case study](https://propfirmconnector.com/vendor-api/case-studies/): Several Rithmic-only futures prop firms let traders use NinjaTrader 8 through the License API, with no new account types, data feed or risk system, and reported a 900% increase in account sales.
- [Vendor API overview](https://propfirmconnector.com/vendor-api/): License API, Coupon API and affiliate program compared, and how to request access.
- [License API integration guide](https://propfirmconnector.com/vendor-api/licensing/): Customer identity, account creation, monthly and lifetime rules, reliable updates, downloads, billing behavior, and launch steps.

## Technical contracts

- [License and download reference in Markdown](https://propfirmconnector.com/vendor-api/licensing.md): Generated from the public OpenAPI contract; includes endpoints, strict request schemas, response examples, permissions, limits, and error handling.
- [License and download OpenAPI 3.1 JSON](https://propfirmconnector.com/vendor-api/licensing/openapi.json): Machine-readable contract for PUT/GET customer licenses and POST addon downloads. Examples are illustrative and contain no usable credentials.
- [Coupon API reference](https://propfirmconnector.com/vendor-api/reference/): The separate coupon model, including discount-code creation, status, redemptions, and signed webhooks. Do not use its request schemas for direct licensing.
- Webhooks (both integrations): one signed HTTPS endpoint per environment, set on the Webhooks page of Vendor Admin. Coupon API events: vendor.discount_code.redeemed, vendor.entitlement.status_changed, vendor.payment.reversed. License API events cover only changes the partner's server did not make: vendor.license.cancelled and vendor.license.email_changed (an administrator changed the license in Vendor Admin) and vendor.license.provisioning_blocked. The same page lists every delivery (event, the discount code or license ID, attempts, last result or failure reason, state, next retry) with a state filter and replay; there is no separate deliveries page. Administrators are emailed when 3 deliveries in a row fail. Documented in the [Coupon API reference](https://propfirmconnector.com/vendor-api/reference/#webhooks) and the [License API guide](https://propfirmconnector.com/vendor-api/licensing/#webhooks).
- Audit log (both integrations): every API response carries X-Correlation-ID; the Vendor Admin Audit log finds a request by it, lists rejected API keys with the reason and source IP, and exports CSV or JSON. GET /vendor/v1/audit-events returns the same events to a key created with the "Audit log (read only)" purpose (scope audit_events:read). Documented in the [License API guide](https://propfirmconnector.com/vendor-api/licensing/#audit-log), the [Coupon API reference](https://propfirmconnector.com/vendor-api/reference/#audit-log) and the OpenAPI contract.

## API key types

Chosen in Vendor Admin when a key is created. Documented in the [License API guide](https://propfirmconnector.com/vendor-api/licensing/#key-types) and the [Coupon API reference](https://propfirmconnector.com/vendor-api/reference/#key-types).

- License management and downloads (sponsored_licenses:write, sponsored_licenses:read, addon:download): Issue, change and check licenses. Request addon download links. Choose it when: One server handles both. The usual License API key.
- License management (sponsored_licenses:write, sponsored_licenses:read): Issue, change and check licenses. Choose it when: A different server requests the downloads.
- Addon download only (addon:download): Request addon download links. Choose it when: A delivery server that must not change licenses.
- Discount codes (discount_codes:create, discount_codes:read, redemptions:list): Create discount codes, check one, and list redemptions. Choose it when: You use the Coupon API. No other key type can create codes.
- Audit log (read only) (audit_events:read): Read your audit log. Choose it when: A monitoring or security tool.
- Vendor Admin lists only the types your organization is approved for.
- A key keeps its type. Rotating it keeps the same permissions; to change type, create a new key and revoke the old one.
- Each environment allows two usable keys in total, across all types, and only one of them may be pending (created but not yet used). With two in use, revoke one before creating or rotating another.

## Product context

- [PropFirmConnector](https://propfirmconnector.com/): Addon capabilities, requirements, and customer setup.
- [Brand assets](https://propfirmconnector.com/brand/): Public brand guidance for partner listings.