input | string | object | Input The search (keyword, or CPV / country filter) this record belongs to. |
recordType | string | Record type tender (one notice; charged) or summary (one per search: counts, sources, warnings; never charged). |
position | integer | Position Rank of the notice in its search's results (1 = first; grouped by source, newest first). |
status | string | Status ok | not_found | error | skipped_invalid | skipped_budget | skipped_free_plan | skipped_unmetered e.g. "ok" |
charged | boolean | Charged Whether this record incurred a pay-per-event charge. |
chargedEvent | string | Charged event Pay-per-event event charged for this record (present only when charged). |
chargedCount | integer | Events charged Events actually charged when the charge came back short of the requested count (present only then; a warning explains it). |
source | string | Source Notice rows: ted, uk-contracts-finder, uk-find-a-tender or usaspending. Summary records: the sources searched (ted+uk-contracts-finder+…). |
fetchedAt | string | Fetched at ISO timestamp. |
noticeId | string | Notice id The source's id, unique within the source: TED publication number, Contracts Finder notice id, Find a Tender notice id, USAspending generated award id (CONT_AWD_…). |
referenceNumber | string | null | Reference The buyer's or platform's reference number, when published (USAspending: the award id / PIID). |
noticeType | string | Notice type tender (call for competition), award, planning (prior information / pipeline) or other. |
title | string | null | Title Notice title (TED: English when the buyer published one, else the original language). |
description | string | null | Description Plain-text excerpt of the description (at most 600 characters). |
buyer | string | null | Buyer Contracting authority or awarding agency. |
country | string | null | Country Buyer country, ISO 3166-1 alpha-2. |
region | string | null | Region NUTS code (EU/UK), UK region (Contracts Finder) or US state of the place of performance or the buyer. |
cpvCodes | array | CPV codes Common Procurement Vocabulary codes, main code first. |
classifications | array | Classifications [{ scheme: CPV | NAICS | PSC, code, description }] (USAspending: NAICS and PSC). |
value | number | null | Value Estimated contract value (tenders) or awarded amount (awards). |
currency | string | null | Currency ISO currency code of value. |
valueType | string | null | Value type estimated or awarded. |
procedureType | string | null | Procedure Procedure (open, restricted, negotiated with prior call…; Find a Tender's wording; USAspending's award type). |
publishedAt | string | null | Published Publication date (YYYY-MM-DD) or timestamp. |
deadline | string | null | Deadline Deadline for tenders (or requests to participate), date or timestamp. |
tenderStatus | string | Tender status open, closed, awarded, planned, cancelled or unknown. |
awardedSuppliers | array | Awarded to Winning suppliers (awards). |
contractStart | string | null | Contract start Start of the contract period, when given. |
contractEnd | string | null | Contract end End of the contract period, when given. |
url | string | null | URL The notice page on the source's website. |
submissionUrl | string | null | Submission URL Where tenders are submitted or the documents are published, when given. |
keyword | string | null | Keyword Summary records: the keyword searched (null for a CPV / country listing). |
resultsDelivered | integer | Notices delivered Summary records: notices delivered (and charged) for the search. |
stopReason | string | Stop reason Summary records: limit, free_plan, end, budget, aborted or error. |
sourcesSearched | array | Sources searched Summary records: the sources asked. |
sourceTotals | object | Matches per source Summary records: matches each source reported (or returned), null when it failed. |
duplicatesSkipped | integer | Duplicates skipped Summary records: notices skipped because an earlier search of the run delivered them (not charged). |
error | object | Error { code, message, provider?, status? } when status is not ok. Codes set by the runtime: budget_exhausted, free_plan_limit, unmetered, aborted, charge_failed, record_too_large, invalid_record, dataset_push_failed; upstream codes: http_error (with the source's HTTP status), timeout, network, tls_error, invalid_json, too_large, rate_limit, server, client, invalid_response, not_found; invalid_input. |
warnings | array | Warnings Notes about this record: sources that failed or were skipped, scan limits, free-plan or budget limits, skipped duplicates. |
raw | object | Raw The source's unmodified notice record (only with includeRaw). |