Learn R Programming

ustfd (version 0.4.4)

filter-syntax: Request filtered API results

Description

Fiscal Data API allows for the filtering of results on the server side, leading to a smaller payload. The combinations of fields and operators supported are not currently defined, so it is suggested you test the desired combinations before relying on them.

Arguments

Syntax

A filter should be a named list of key-value pairs where the name corresponds to the field that should be filtered and the value is a character vector or a list where the name of an item corresponds to the operator and the value corresponds to the operand. One field may have more than one filter.

Operators

  • >, < Greater-than and lesser-than

  • >=, <= Greater-/lesser-than or equal-to

  • = Equal to

  • in Subset-of