Get an export

GET/exports/{export_id}

An export's status and, once completed, a signed download link for every file, valid for 60 minutes; call again for fresh links. Poll every few seconds to a minute: an export starts within about a minute and a full listings snapshot takes a few minutes.

Authentication: Send a data key (dk_live_… or dk_test_…) as a Bearer token.
Scope: reference
Cost: Free

Parameters

Name	Type	Description
`export_id`requiredpath	`string`

Response

The data field is an object with these fields.

Name	Type	Description
`id`required	`string`
`dataset`required	`string`	One of: `listings`, `listing_changes`, `registered_transactions`, `registered_rents`
`format`required	`string`	One of: `ndjson`, `csv`
`compression`required	`string`	One of: `gzip`, `none`
`status`required	`string`	`queued` → `running` → `completed`, or `failed`. `expired` once the files are deleted. One of: `queued`, `running`, `completed`, `failed`, `expired`
`filters`required	`object \| null`	As requested. Null once complete if your organization has turned off storing request details.
`price_source`required	`string`	Where the prices come from: `asking` = advertised asking prices from listings; `registered` = registered transactions or rent contracts. Asking prices typically sit above what is finally agreed. One of: `asking`, `registered`
`rows_estimated`required	`integer \| null`	Rows counted before a listing export ran, which `units` is priced on.
`row_count`required	`integer \| null`	Rows written, once complete.
`units`required	`integer`	Units charged. 0 for open data, and refunded if the export fails.
`progress`required	`object`
`error`required	`object \| null`
`attribution`required	`object \| null`	Open-data exports: the licence notice, also in ATTRIBUTION.txt. Keep it with the data.
`files`required	`object[]`	Download links, on GET /exports/{export_id} of a completed export only.
`created_at`required	`string (date-time)`
`started_at`required	`string (date-time) \| null`
`completed_at`required	`string (date-time) \| null`
`expires_at`required	`string (date-time) \| null`	When the files are deleted.

Example request

curl

curl "https://api.kite.sa/v1/exports/export_id" \
  -H "Authorization: Bearer $KITE_API_KEY"

JavaScript (@kite-sa/sdk)

import { Kite } from "@kite-sa/sdk";

const kite = new Kite(); // reads KITE_API_KEY
const result = await kite.exports.get("export_id");

Python (kite-sa)

from kite_sa import Kite

kite = Kite()  # reads KITE_API_KEY
result = kite.exports.get("export_id")

Open in the interactive reference

Related endpoints

Create an export POST /exports
List exports GET /exports

Guides

Exports