Treasury Offset Program
Treasury Offset Program
10/01/1999 — 06/01/2020Updated MonthlyCSV, JSON, XMLData Dictionary
This dataset shows how Treasury offsets federal payments, such as tax refunds, to pay off delinquent debts such as unpaid child support.
About This Dataset
Description:
This dataset is a summary of five different programs in which states, the District of Columbia (D.C.), and U.S. territories can apply offsets from federal payments towards delinquent debt. These programs are income tax, state reciprocal tax agreements, unemployment insurance, child support, and Supplemental Nutrition Assistance Program (SNAP)....
| Data Table Name | Field Name | Display Name | Description | Data Type | Is Required |
|---|
Showing 1 - 1 rows of 45 rows
Rows Per Page
- 5
- 10
- 20
- 50
- 100
| Table Name | Description | Row Description | File Sizes | Row Count |
|---|
Showing 1 - 1 rows of 2 rows
| Name | Definition |
|---|
Showing 1 - 1 rows of 7 rows
Notes & Known Limitations
This dataset tracks Treasury Offset Program (TOP) collections and participation. With state programs, states and territories can participate in state income tax referrals (41 states and D.C. have state income tax), state reciprocal program, state unemployment insurance (UI) debts (tax withholding and UI overpayment), SNAP debts (with federal component) and child support collections (with federal component). Not all states participate in all programs. This is not tracked for the federal non-tax creditor agencies.
States participating in the State Reciprocal Program have their debts offset against federal payments for state income tax and unemployment insurance compensation debts. The Department of Agriculture's Food and Nutrition Service manages the federal aspects of the SNAP program and refers debts to the U.S. Department of the Treasury for TOP. For the purposes of the TOP, SNAP debts are considered federal debts even though they are administered by states and territories.
Preview
Date Range (Record Date):
API Quick Guide
Check out our more detailed API Documentation.
Endpoints
BASE URL:
https://www.transparency.treasury.gov/services/api/fiscal_service| Table Name | Endpoint |
|---|
Showing 1 - 1 rows of 2 rows
Rows Per Page
- 5
- 10
- 20
- 50
- 100
FULL URL:
https://www.transparency.treasury.gov/services/api/fiscal_service/v1/debt/top/top_federalFields
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 | Data Table Name |
|---|
Showing 1 - 1 rows of 45 rows
Rows Per Page
- 5
- 10
- 20
- 50
- 100
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 limitationsFields
- 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=country_currency_desc,exchange_rate,data_datehttps://www.transparency.treasury.gov/services/api/fiscal_service/v1/accounting/od/exchange_rates?fields=country_currency_desc,exchange_rate,data_dateFilters
- 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 formatYYYY-MM-DD. - Requried: 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 thanlte= Less than or equal togt= Greater thangte= Greater than or equal toeq= Equal toin= Contained in a given set
EXAMPLE
?filter=reporting_fiscal_year:in:(2007,2008,2009,2010)?filter=funding_type_id:eq:202https://www.transparency.treasury.gov/services/api/fiscal_service/v1/accounting/od/exchange_rates?fields=country_currency_desc,exchange_rate,data_date&filter=country_currency_desc:in:(canada-dollar,mexico-peso)&filter=data_date:gte:2019-01-01Sorting
- 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=-data_datehttps://transparency.treasury.gov/services/api/fiscal_service/v1/debt/tror?sort=funding_type_idhttps://www.transparency.treasury.gov/services/api/fiscal_service/v1/accounting/od/debt_to_penny?fields=reporting_calendar_year,reporting_calendar_month&sort=-reporting_calendar_year,-reporting_calendar_monthFormat
- Parameter:
format= - Definition: The format parameter allows a user to define the output method of the response (CSV, JSON, XML).
- Accepts: The
format=parameter acceptsxml,json, orcsvas 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=csvhttps://transparency.treasury.gov/services/api/fiscal_service/v1/debt/tror?format=jsonPagination
- Parameter:
page[size]=andpage[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]=andpage[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
https://transparency.treasury.gov/services/api/fiscal_service/v1/debt/top/state_programs?page[number]=10&page[size]=50Methods
Our APIs accept the GET method, one of the most common HTTP methods.Example API Requests
In this example, we are...
- Requesting exchange rate data
- Listing out the fields we would like displayed
country_currency_desc, exchange_rate, data_date - Filtering the data in order to return data ranging from 03-31-2015 (inclusive) through present day
- Formatting the response in a JSON format
- Sorting the data by date (default is ascending)
EXAMPLE REQUEST
https://www.transparency.treasury.gov/services/api/fiscal_service/v1/accounting/od/exchange_rates?fields=country_currency_desc,exchange_rate,data_date&filter=country_currency_desc:in:(CANADA-DOLLAR,MEXICO-PESO)&filter=data_date:gte:2019-01-01&format=json&sort=data_dateEXPECTED RESPONSE
{"data":[{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.277","data_date":"2015-03-31"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.238","data_date":"2015-06-30"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.341","data_date":"2015-09-30"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.386","data_date":"2015-12-31"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.293","data_date":"2016-03-31"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.295","data_date":"2016-06-30"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.316","data_date":"2016-09-30"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.346","data_date":"2016-12-31"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.334","data_date":"2017-03-31"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.297","data_date":"2017-06-30"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.243","data_date":"2017-09-30"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.255","data_date":"2017-12-31"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.288","data_date":"2018-03-31"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.324","data_date":"2018-06-30"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.301","data_date":"2018-09-30"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.362","data_date":"2018-12-31"},{"country_currency_desc":"MEXICO-PESO","exchange_rate":"19.654","data_date":"2018-12-31"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.341","data_date":"2019-03-31"},{"country_currency_desc":"MEXICO-PESO","exchange_rate":"19.295","data_date":"2019-03-31"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.309","data_date":"2019-06-30"},{"country_currency_desc":"MEXICO-PESO","exchange_rate":"19.175","data_date":"2019-06-30"},{"country_currency_desc":"CANADA-DOLLAR","exchange_rate":"1.325","data_date":"2019-09-30"},{"country_currency_desc":"MEXICO-PESO","exchange_rate":"19.725","data_date":"2019-09-30"}],"meta":{"count":23,"labels":{"country_currency_desc":"Country - Currency Description","exchange_rate":"Exchange Rate","data_date":"Data Date"},"dataTypes":{"country_currency_desc":"STRING","exchange_rate":"NUMBER","data_date":"DATE"},"dataFormats":{"country_currency_desc":"String","exchange_rate":"10.2","data_date":"YYYY-MM-DD"},"total-count":23,"total-pages":1},"links":{"self":"&page%5Bnumber%5D=1&page%5Bsize%5D=100","first":"&page%5Bnumber%5D=1&page%5Bsize%5D=100","prev":null,"next":null,"last":"&page%5Bnumber%5D=1&page%5Bsize%5D=100"}}For More API Information
Visit our full API documentation to find out more about:
- Aggregation and sums
- Pivoting
- Response codes
- Meta object
- ...and more!
Related Datasets
© 2020 Data Transparency