Query contributions
Returns the records that match the filters, latest upload first, and charges the company for the records it sees for the first time.
What is returned: active and flagged records that have not expired. A privileged record is returned only to its own company and to the companies it has approved.
What is charged, with fetch-mode=DEFAULT:
- Own records are free and counted in
details.self. - Records bought before are free and counted in
details.old. - Records of a privileged company that approved the caller's company are free and counted in
details.new. - Every other record is bought and counted in
details.new. The price is per identifier: a range costs the price times the number of values in it. Email addresses and URLs cost nothing. - A record the balance does not cover is not returned. It is counted in
details.contributionsNotReturnedand its cost is added todetails.contributionsNotReturnedCost.
Companies on the TRIAL and PAID subscriptions are not charged.
The counters of the answer are in details.
Repeat ft, org and dst to pass several values, for example ?ft=Wangiri&ft=IRSF.
Authorizations
The accessToken of a sign-in or refresh answer. Valid for 5 minutes.
Parameters
Query Parameters
The most records to return. Without it all matching records are returned.
50"int32"0Return records uploaded at or after this time. An ISO 8601 date-time with an offset or Z. Encode a + of the offset as %2B.
"2026-01-01T00:00:00Z""date-time"Return records uploaded at or before this time. An ISO 8601 date-time with an offset or Z. Encode a + of the offset as %2B.
"2026-01-31T23:59:59Z""date-time"Return only records of these fraud types. Repeat the parameter for several types. Without it all types are returned. Names that are not fraud types are ignored. Not applied with fetch-mode=SELF.
"Wangiri""IRSF"Return only records with one of these origination countries (ISO 3166-1 alpha-2). Repeat the parameter for several countries.
"GB""IS"Return only records with one of these destination countries (ISO 3166-1 alpha-2). Repeat the parameter for several countries.
"NZ""FJ"Which records to return.
DEFAULT: own records, records bought before, and records not seen before, which are bought.NEW: only records that other companies uploaded and that the company has never bought. They are bought. A record another company uploaded with the caller's company as its source is included.OLD: only own records and records bought before. Nothing is charged.SELF: only records the company uploaded itself. Records that name it as the source are not included, andftis not applied. Nothing is charged.
"DEFAULT""NEW""OLD""SELF""DEFAULT""DEFAULT"Reserved. Ignored; always empty.
falsefalseResponses
The matching records and what the query cost.