Data hub
Exports of the broker's data, and the imports that bring a book into BrokerPlus.
List imports
The imports on the broker's teams, newest first, as the Import page lists them. An import brings one or more files or syncs into the book. Each import lists its sources with what was read and what failed.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
List imports › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Add a deals file to an import
Adds a deals export (.csv, .xlsx or .xls) to the team's open import, or starts one, the same as an upload on the Import page. Send the file as multipart/form-data in a file field, or as JSON with content_base64. BrokerPlus reads and maps it in the background: poll GET /import-runs/{id}. Nothing is added to the book until the broker reviews the import and adds it in BrokerPlus.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Add a deals file to an import › Request Body
fileThe file: a .csv, .xlsx or .xls export. At most 100 MB.
providerThe system the file was exported from.
modeadditive (the default) or overwrite.
nameA name for the source. The file name by default.
Add a deals file to an import › Responses
Success
successAlways true on a successful response.
The requested record.
List import status routes
Where an import sends a deal by the status word the other system wrote, as Settings > Import shows it. The routes are the brokerage's, and every import uses them.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
List import status routes › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Save import status routes
Saves the routes you send, the same as the mapping form in Settings > Import, and leaves every other route as it is. A route names a pipeline and stage, or a placement. Send neither to delete the route. A pipeline the key's broker cannot change, or a stage that is not on it, is left out of the route. Imports that already ran keep where they put the deals.
Save import status routes › Request Body
The routes to save, at most 500. A route you do not send stays as it is.
Save import status routes › Responses
Success
successAlways true on a successful response.
The requested record.
List saved import mappings
The column mappings the brokerage saved from past imports, newest change first. The next file with the same column headers is mapped the same way.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
List saved import mappings › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Delete a saved import mapping
Deletes the mapping for the whole brokerage. The next file with the same headers is mapped from scratch. Only a key that belongs to a brokerage admin can delete one.
path Parameters
idResource id.
Delete a saved import mapping › Responses
Success
successAlways true on a successful response.
The requested record.
Update a saved import mapping
Renames the mapping or replaces its columns, the same as Settings > Import. Only a key that belongs to a brokerage admin can change a saved mapping. An import that already ran keeps how it was mapped.
path Parameters
idResource id.
Update a saved import mapping › Request Body
nameA name for the mapping. Send null to clear it.
The whole new column list. It replaces the old one.
Update a saved import mapping › Responses
Success
successAlways true on a successful response.
The requested record.
List data export packages
The packages a broker can export, as the Export page shows them. Send a package's id as package_id.
List data export packages › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
List data exports
The exports the key's broker requested, newest first. Another broker's exports are never listed, the same as in BrokerPlus.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
List data exports › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Request a data export
Starts an export of one package, built in the background from the records the key's broker can read. If an export of the same package is already pending or running, you get that export. The files stay for 30 days. Download them in BrokerPlus: the API does not give the files.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Request a data export › Request Body
package_idThe package to export. Get the packages from GET /v1/data-exports/packages.
Request a data export › Responses
Success
successAlways true on a successful response.
The requested record.
Cancel a data export
Stops an export that is pending or running.
path Parameters
idResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Cancel a data export › Responses
Success
successAlways true on a successful response.
The requested record.