U.S. Government Revenue Collections

About This Dataset

Description:

The U.S. Government Revenue Collections dataset provides a daily overview of federal revenue collections such as individual and corporate income tax deposits, customs duties, fees for government service, fines, and loan repayments. These collections can be made through either electronic or non-electronic transactions by mail, internet, bank, or over-the-counter channels.

Data Table Name	Field Name	Display Name	Description	Data Type	Is Required

Showing 1 - 1 rows of 15 rows

API Quick Guide

Endpoint

BASE URL:

https://api.fiscaldata.treasury.gov/services/api/fiscal_service

ENDPOINT:

FULL URL:

https://api.fiscaldata.treasury.gov/services/api/fiscal_service/

Fields

Refer to About This Dataset above for a data dictionary with field names and descriptions, as well as notes and known limitations.

Field Name	Display Name	Data Type

Showing 1 - 1 rows of 15 rows

Data Types

All data is returned as a string, including nulls. Refer to the chart above for the intended data type of each field.

Parameters

Refer to About This Dataset above for a data dictionary with field names and descriptions as well as notes and known limitations

Fields

Parameter: fields=
Definition: The fields parameter allows you to select which field(s) should be included in the response.
Accepts: The fields= parameter accepts a comma-separated list of field names (no parentheses).
Required: No, specifying fields is not required to make an API request.
Default: If desired fields are not specified, all fields will be returned.
Notes: When a field named passed to the fields= parameter is not available for the endpoint accessed, an error will occur. Note that omitting fields can result in automatically aggregated and summed data results. For more information, view the full documentation on Aggregation and Sums.

EXAMPLE

?fields=

Filters

Parameter: filter=
Definition: Filters are used to view a subset of the data based on specific criteria. For example, you may want to find data that falls within a certain date range, or only show records which contain a value larger than a certain threshold.
Accepts: The filter parameter filter= accepts filters from the list below, as well as specified filter criteria. Use a colon at the end of a filter parameter to pass a value or list of values. For lists passed as filter criteria, use a comma-separated list within parentheses. Filter for specific dates using the format YYYY-MM-DD.
Required: No, filters are not required to make an API request.
Default: When no filters are provided, the default response will return all fields and all data.

The filter parameter accepts the following filters:

lt = Less than
lte = Less than or equal to
gt = Greater than
gte = Greater than or equal to
eq = Equal to
in = Contained in a given set

EXAMPLE

?filter=undefined:eq:undefined
https://api.fiscaldata.treasury.gov/services/api/fiscal_service/undefined?filter=undefined:eq:undefined

Sorting

Parameter: sort=
Definition: The sort parameter allows a user to sort a field in ascending (least to greatest) or descending (greatest to least) order.
Accepts: The sort parameter sort= accepts a comma-separated list of field names.
Required: No, sorting is not required to make an API request.
Default: When no sort parameter is specified, the default is to sort by the first column listed. Most API endpoints are thus sorted by date in ascending order (historical to most current).
Notes: You can nest sorting by passing the sort= parameter a comma-separated list.

EXAMPLE

?sort=-undefined
https://api.fiscaldata.treasury.gov/services/api/fiscal_service/undefined?sort=-undefined

Format

Parameter: format=
Definition: The format parameter allows a user to define the output method of the response (CSV, JSON, XML).
Accepts: The format= parameter accepts xml,json, or csv as an input.
Required: No, the format parameter is not required to make an API request.
Default: When no format is specified, the default response format is JSON.

EXAMPLE

?format=csv

Pagination

Parameter: page[size]= and page[number]=
Definition: The page size will set the number of rows that are returned on a request, and page number will set the index for the pagination, starting at 1. This allows the user to paginate through the records returned from an API request.
Accepts: The page[number]= and page[size]= parameters both accept integers.
Required: No, neither pagination parameters are required to make an API request.
Default: When no page number or page size parameter is specified, the default response is
- Page number: 1
- Page size: 100

EXAMPLE

Methods

Our APIs accept the GET method, one of the most common HTTP methods.

Example Request & Response

In this example, we are...

Specifying the endpoint
Requesting the JSON response format
Sorting the data by in descending order
Setting pagination parameters

EXAMPLE REQUEST

https://api.fiscaldata.treasury.gov/services/api/fiscal_service/undefined?sort=-undefined&format=json&page[number]=1&page[size]=1

EXPECTED RESPONSE

Loading...

U.S. Government Revenue Collections

About This Dataset

Description:

Notes & Known Limitations

Preview

API Quick Guide

For More API Information

U.S. Government Revenue Collections

About This Dataset

Description:

Notes & Known Limitations

Preview

API Quick Guide

Related Datasets