Download v2 Transaction Count API

download_v2_count.md

Download Transaction Count API

/v2/download/count (POST)

Returns the number of transactions that would be included in a download request for the given filter set.

Request

POST a JSON body:

{
    "filters": {
        "time_period": [
            {
                "start_date": "2001-01-01",
                "end_date": "2001-01-31"
            }
        ]
    }
}

Request Parameters Description

• filters - required - a standard Search v2 JSON filter object

Response

{
    "transaction_rows_gt_limit": true
}

• transaction_rows_gt_limit is a boolean returning whether the transaction count is over the maximum row limit.

Note: This endpoint will only count the rows for transactions. Frontend will disable the download button whenever transaction row count exceeds 500,000 regardless of the award row count. We'll name the key transaction_rows in case we need to add award counts in the future.