Skip to main content
POST
Make a job that reads the investor transactions of up to 10,000 parcels
This route serves the dataset under /v3/jobs/transactions. See The dataset for the tier rules and Investor transactions for the job and its results. A repeated request with one body on one build answers the job that exists.

Authorizations

Authorization
string
header
required

API key from the developer console (starts with zpka_). Create one at https://developers.investorlift.com/get-a-key. The same key works on POST /mcp.

Body

application/json

The job form: up to 10,000 parcels and transactions in all, computed in the background.

property_ids
string[]

The parcels to read, 32 hex characters each. A duplicate is answered once. The list form takes 500 parcels and transactions in all, the job form 10,000.

Maximum array length: 20000

An id of the deed cut: 32 hex characters.

Pattern: ^[0-9a-f]{32}$
transactions
object[]

The transactions to place: each a parcel id with a date, or a deal id. The parcel of a transaction joins the parcels of the request.

Maximum array length: 20000
since
string<date>

Keep the investor purchases dated on or after this day, YYYY-MM-DD. The set holds 20 deeds at most on a parcel, so an old purchase is absent anyway.

outcomes
enum<string>[]

Keep the investor purchases of these outcomes. The counts of the block and the role of a transaction still read every investor purchase.

Minimum array length: 1

The outcome of the investor purchase, one word over its resale and the data end of the state. quick_resale: the next priced deed of the parcel is 0 to 29 days after the purchase. flip: the next priced deed is 30 to 365 days after the purchase, both legs carry a price, and the resale price over the price minus one is 0.10 to 1.50. flip_window_other: the next priced deed is 30 to 365 days after the purchase, and the spread is outside that band or a leg carries no price. long_hold_sale: the next priced deed is more than 365 days after the purchase. held: no later priced deed by the data end, and the purchase is more than 365 days before the data end. open: no later priced deed by the data end, and the purchase is inside the 365 days before the data end, so the outcome is not known yet. The thresholds are the ones of the organization profile.

Available options:
quick_resale,
flip,
flip_window_other,
long_hold_sale,
held,
open
detail
boolean

True adds the blocks that cost a probe each: the track record of each buyer, the sellers, the buyers of the resale, the entry, the purchase loan, the exit and the owner. False, the default, answers the outcome, both legs, the flags and the investor by name and id, and reads null for the rest. The default is the fast shape.

wait
integer

Hold the request up to this many seconds for the job, 1 to 20. A job done in time answers 200 with its record, else 202. The job id does not read it.

Required range: 1 <= x <= 20

Response

The job is done inside wait: its record, with the results on the results route.

The job is done inside wait: its record, with the results on the results route.

data
object
required

One job of the investor transactions: its status, its counts, its times and the build it ran on.

meta
object
required

Response metadata of the /v3 family: when the API produced it, and the publishes behind the rows.