JSON API
Your software retrieves complete allocations, decision history and dated performance over HTTPS using a partner key. Your team maps the securities and target weights into its portfolio workflow.
Available through the partner APISee what we offer brokers, advisors and robo-advisors, then use this page to plan how your team receives portfolio targets. You keep the client relationship, account controls and execution.
We agree the portfolios, supported stock listings, identifier mapping and update process with your team. Your firm controls client account allocation, risk checks and execution. JSON is a standard data format; each platform connection still needs mapping and testing.
The API is available to partners. Authenticated partner endpoints provide complete allocations, decision history, performance, changes, portfolio permissions and durable delivery receipts.
Use a partner key in the Authorization header. File access follows the same portfolio permissions as the target API; each successful download records delivery, with no execution claim. The API reference lists the formats and response details.
GET /api/v1/partner/portfolios/{slug}/files/{format}
GET /api/v1/partner/files/{format}.zipFormats: ibkr-rebalance, csv, xlsx. An optional rebalance_id selects a saved decision for an individual file. The ZIP contains the latest published decision for each entitled portfolio. Files use the published decision, including zero-weight exits. Organization-specific custom CSV is also available after assisted onboarding when a valid layout and all required exact-instrument mappings are configured. Check GET /api/v1/partner/formats for your current availability; authenticated portal downloads reflect the same configuration. Custom file preparation does not verify platform imports.
Review the IBKR layout, allocation basis and verification table below before using any file. Platform identifiers and supported securities require verification for your configuration.
This illustrative 5% target is a layout example, not a portfolio recommendation. The file has no header; the last of its ten columns holds the percentage.
DES,AAPL,STK,SMART/AMEX,,,,,,5A 5% target means 5% of the capital the platform rebalances. For an account worth $100,000, that is $5,000. When the client holds other investments in the same account, partners set the strategy's share of the account when downloading the IBKR file: with 30%, each 5% target becomes 1.5%. In the IBKR paper test, holdings outside the file were left alone. A 30% file was verified in the paper account on 22 September 2026.
Verified 2026-09-22 in an individual IBKR paper account (TWS Rebalance Portfolio; orders created, not sent):
Not verified: Sent orders and fills. Advisor accounts, account groups and the Model window. Class shares (for example BRK B). Browser-portal import. The venue table shares the same verification record as the file generator.
| Source venue | IBKR venue | Symbol mapping | Verification |
|---|---|---|---|
| US | SMART/AMEX | Remove .US; class A/B separators become spaces (BRK.B → BRK B). | Verified 2026-09-22SMART/AMEX is how TWS labels every US stock (NASDAQ, NYSE and NYSE American alike); a bare SMART and SMART/NASDAQ or SMART/NYSE are refused. |
| SR | TADAWUL | Remove .SR; the four-digit Saudi Exchange code is the symbol (1120.SR → 1120). | Not verifiedSaudi Alpha. The account needs IBKR's Saudi Exchange trading permission; paper import pending. |
Match the exact share class, listing, currency and ISIN where supplied. A matching company name or similar ticker is insufficient; an ADR, CFD or another listing is not a substitute.
These guides use official platform documentation. The IBKR TWS Rebalance import is paper-verified (22 September 2026); the Saxo Model Manager setup is unverified.
Email updates with shared attachments can be configured for explicitly opted-in partner staff. WhatsApp provides portfolio alerts with no holdings after verified opt-in. Download the decision calendar. The partner portal is available for enabled teams, with a public masked demo.
Available to configured partners. Receive signed model.published and model.corrected events with saved decision and correction IDs, publication and effective times, a model-content hash and authenticated target/file links. Daily valuations do not create another model event.
Verify X-XP-Signature using HMAC-SHA256 over the exact timestamp.body bytes and check X-XP-Timestamp within five minutes. Delivery is at-least-once: a lost response can cause redelivery, so save and deduplicate the event ID before applying a model. HTTP acceptance does not confirm downstream processing or execution.
Requests have a ten-second bound. Temporary failures retry after 1, 5, 30 and 120 minutes, with five attempts in total. Recover missed events through GET /api/v1/partner/webhooks/replay, using the returned cursor and your Bearer key. On an unavailable cursor, restart without it and deduplicate saved IDs. Links contain no API keys.
Download the Python signature verifier alongside the sample consumer and replay example. The delivery contract defines the exact content hash, signing bytes, retries and secret rotation. Pre-existing history identifies its first retained publication receipt; decision and effective dates are preserved.
Available to configured partners as a private, read-only folder that your team downloads from. Supply a dedicated Ed25519 public key during onboarding; verify the assigned server host-key fingerprint before connecting. Your account sees only its organization’s entitled files and cannot run commands, forward connections or upload changes.
Start with /exports/index.json. Each complete decision folder includes a manifest with decision/correction IDs and exact file hashes. Download to temporary local files, verify the manifest and file hashes, then import through your own workflow. Corrections have separate decision folders; reruns and daily valuations reuse existing file sets.
Choose generic CSV/XLSX, IBKR Rebalance CSV or a configured custom CSV. The delivery channel does not change what a platform import needs. Files being available do not prove download, acknowledgement or execution. Connection, revocation and recovery instructions.
Share your platform and the US and Saudi stock listings it supports so we can agree portfolio access. Assisted onboarding is included.
Discuss your integration