data-analyst-mcp 0.3.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. package/README.md +28 -4
  2. package/dist/adapters/bjs.d.ts +13 -0
  3. package/dist/adapters/bjs.js +28 -0
  4. package/dist/adapters/bjs.js.map +1 -0
  5. package/dist/adapters/cbp.d.ts +5 -0
  6. package/dist/adapters/cbp.js +64 -0
  7. package/dist/adapters/cbp.js.map +1 -0
  8. package/dist/adapters/cdc-wonder.d.ts +5 -0
  9. package/dist/adapters/cdc-wonder.js +68 -0
  10. package/dist/adapters/cdc-wonder.js.map +1 -0
  11. package/dist/adapters/cpsc.d.ts +4 -0
  12. package/dist/adapters/cpsc.js +125 -0
  13. package/dist/adapters/cpsc.js.map +1 -0
  14. package/dist/adapters/fhwa.d.ts +9 -0
  15. package/dist/adapters/fhwa.js +16 -0
  16. package/dist/adapters/fhwa.js.map +1 -0
  17. package/dist/adapters/foreign-assistance.d.ts +9 -0
  18. package/dist/adapters/foreign-assistance.js +42 -0
  19. package/dist/adapters/foreign-assistance.js.map +1 -0
  20. package/dist/adapters/hud-ahar.d.ts +3 -0
  21. package/dist/adapters/hud-ahar.js +80 -0
  22. package/dist/adapters/hud-ahar.js.map +1 -0
  23. package/dist/adapters/nces.d.ts +10 -0
  24. package/dist/adapters/nces.js +32 -0
  25. package/dist/adapters/nces.js.map +1 -0
  26. package/dist/adapters/nsf.d.ts +11 -0
  27. package/dist/adapters/nsf.js +25 -0
  28. package/dist/adapters/nsf.js.map +1 -0
  29. package/dist/adapters/onrr.d.ts +9 -0
  30. package/dist/adapters/onrr.js +35 -0
  31. package/dist/adapters/onrr.js.map +1 -0
  32. package/dist/adapters/sba.d.ts +10 -0
  33. package/dist/adapters/sba.js +134 -0
  34. package/dist/adapters/sba.js.map +1 -0
  35. package/dist/adapters/treasury-tic.d.ts +30 -0
  36. package/dist/adapters/treasury-tic.js +149 -0
  37. package/dist/adapters/treasury-tic.js.map +1 -0
  38. package/dist/adapters/uscourts.d.ts +8 -0
  39. package/dist/adapters/uscourts.js +8 -0
  40. package/dist/adapters/uscourts.js.map +1 -0
  41. package/dist/analysis/cite.d.ts +9 -1
  42. package/dist/analysis/cite.js +9 -2
  43. package/dist/analysis/cite.js.map +1 -1
  44. package/dist/bin/cli.d.ts +2 -0
  45. package/dist/bin/cli.js +17 -0
  46. package/dist/bin/cli.js.map +1 -1
  47. package/dist/core/generic-rest.js +42 -17
  48. package/dist/core/generic-rest.js.map +1 -1
  49. package/dist/core/guard.d.ts +32 -0
  50. package/dist/core/guard.js +176 -0
  51. package/dist/core/guard.js.map +1 -0
  52. package/dist/core/http.d.ts +10 -0
  53. package/dist/core/http.js +36 -7
  54. package/dist/core/http.js.map +1 -1
  55. package/dist/core/keys.d.ts +13 -3
  56. package/dist/core/keys.js +67 -7
  57. package/dist/core/keys.js.map +1 -1
  58. package/dist/core/package.d.ts +12 -3
  59. package/dist/core/package.js +56 -12
  60. package/dist/core/package.js.map +1 -1
  61. package/dist/core/secret_patterns.d.ts +6 -0
  62. package/dist/core/secret_patterns.js +20 -0
  63. package/dist/core/secret_patterns.js.map +1 -0
  64. package/dist/core/tabular.d.ts +43 -1
  65. package/dist/core/tabular.js +149 -6
  66. package/dist/core/tabular.js.map +1 -1
  67. package/dist/envelope.js +3 -1
  68. package/dist/envelope.js.map +1 -1
  69. package/dist/index.d.ts +29 -22
  70. package/dist/index.js +45 -46
  71. package/dist/index.js.map +1 -1
  72. package/dist/remote/app.js +87 -31
  73. package/dist/remote/app.js.map +1 -1
  74. package/dist/remote/oauth.js +8 -1
  75. package/dist/remote/oauth.js.map +1 -1
  76. package/dist/remote/pages.d.ts +3 -7
  77. package/dist/remote/pages.js +49 -19
  78. package/dist/remote/pages.js.map +1 -1
  79. package/dist/remote/sign.d.ts +7 -1
  80. package/dist/remote/sign.js +33 -7
  81. package/dist/remote/sign.js.map +1 -1
  82. package/dist/remote/store.js +14 -5
  83. package/dist/remote/store.js.map +1 -1
  84. package/dist/report/audit_report.js +29 -7
  85. package/dist/report/audit_report.js.map +1 -1
  86. package/dist/report/build_report.js +34 -4
  87. package/dist/report/build_report.js.map +1 -1
  88. package/dist/report/method_audit.js +3 -0
  89. package/dist/report/method_audit.js.map +1 -1
  90. package/dist/report/scan_secrets.js +2 -13
  91. package/dist/report/scan_secrets.js.map +1 -1
  92. package/dist/server.d.ts +3 -1
  93. package/dist/server.js +44 -12
  94. package/dist/server.js.map +1 -1
  95. package/dist/tools.js +27 -6
  96. package/dist/tools.js.map +1 -1
  97. package/guide/assets/download_data.ps1 +2 -0
  98. package/guide/assets/download_data.sh +8 -2
  99. package/guide/references/routing.md +30 -3
  100. package/package.json +1 -1
  101. package/packs/bjs/endpoints.json +150 -0
  102. package/packs/bjs/policy.json +114 -0
  103. package/packs/bjs/source.md +98 -0
  104. package/packs/cbp/endpoints.json +31 -0
  105. package/packs/cbp/policy.json +85 -0
  106. package/packs/cbp/source.md +57 -0
  107. package/packs/cdc/source.md +1 -1
  108. package/packs/cdc-wonder/endpoints.json +26 -0
  109. package/packs/cdc-wonder/policy.json +84 -0
  110. package/packs/cdc-wonder/source.md +53 -0
  111. package/packs/college-scorecard/source.md +1 -1
  112. package/packs/cpsc/endpoints.json +91 -0
  113. package/packs/cpsc/policy.json +91 -0
  114. package/packs/cpsc/source.md +76 -0
  115. package/packs/dhs-ohss/source.md +1 -1
  116. package/packs/doj-news/source.md +1 -1
  117. package/packs/fbi/source.md +3 -3
  118. package/packs/fhwa/endpoints.json +48 -0
  119. package/packs/fhwa/policy.json +91 -0
  120. package/packs/fhwa/source.md +59 -0
  121. package/packs/foreign-assistance/endpoints.json +166 -0
  122. package/packs/foreign-assistance/policy.json +80 -0
  123. package/packs/foreign-assistance/source.md +76 -0
  124. package/packs/fsa/source.md +1 -1
  125. package/packs/hud/source.md +1 -1
  126. package/packs/hud-ahar/endpoints.json +92 -0
  127. package/packs/hud-ahar/policy.json +88 -0
  128. package/packs/hud-ahar/source.md +72 -0
  129. package/packs/naep/source.md +1 -1
  130. package/packs/nces/endpoints.json +101 -0
  131. package/packs/nces/policy.json +99 -0
  132. package/packs/nces/source.md +75 -0
  133. package/packs/nhtsa/source.md +1 -1
  134. package/packs/nsf/endpoints.json +33 -0
  135. package/packs/nsf/policy.json +83 -0
  136. package/packs/nsf/source.md +59 -0
  137. package/packs/onrr/endpoints.json +198 -0
  138. package/packs/onrr/policy.json +91 -0
  139. package/packs/onrr/source.md +55 -0
  140. package/packs/port.json +65 -0
  141. package/packs/sba/endpoints.json +34 -0
  142. package/packs/sba/policy.json +86 -0
  143. package/packs/sba/source.md +60 -0
  144. package/packs/treasury/source.md +1 -1
  145. package/packs/treasury-tic/endpoints.json +77 -0
  146. package/packs/treasury-tic/policy.json +89 -0
  147. package/packs/treasury-tic/source.md +80 -0
  148. package/packs/uscourts/endpoints.json +22 -0
  149. package/packs/uscourts/policy.json +87 -0
  150. package/packs/uscourts/source.md +56 -0
  151. package/packs/uspto/source.md +1 -1
@@ -0,0 +1,83 @@
1
+ {
2
+ "id": "nsf",
3
+ "title": "National Science Foundation awards (NSF Award Search API)",
4
+ "agency": "U.S. National Science Foundation",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "science",
8
+ "research funding",
9
+ "federal grants"
10
+ ],
11
+ "keywords": [
12
+ "nsf",
13
+ "national science foundation",
14
+ "nsf grants",
15
+ "nsf awards",
16
+ "research grants",
17
+ "science funding",
18
+ "principal investigator",
19
+ "epscor",
20
+ "career award",
21
+ "graduate research fellowship",
22
+ "directorate",
23
+ "research funding by university"
24
+ ],
25
+ "questions": [
26
+ "NSF awards to a university in a year",
27
+ "NSF grants on a research topic (e.g. quantum computing)",
28
+ "NSF funding by state",
29
+ "awards from an NSF program",
30
+ "a researcher's NSF awards"
31
+ ],
32
+ "homepage": "https://www.nsf.gov/awardsearch/",
33
+ "terms_url": "https://resources.research.gov/common/webapi/awardapisearch-v1.htm",
34
+ "auth": {
35
+ "env": null,
36
+ "required": "none",
37
+ "placement": "none",
38
+ "signup_url": null,
39
+ "echoes_key": false
40
+ },
41
+ "limits": {
42
+ "rps": 2,
43
+ "burst": 4,
44
+ "max_rows": 10000
45
+ },
46
+ "routes": {
47
+ "api": {
48
+ "base": "https://api.nsf.gov/services/v1",
49
+ "probe": "https://api.nsf.gov/services/v1/awards.json?id=2600000",
50
+ "hosts": [
51
+ "api.nsf.gov"
52
+ ]
53
+ },
54
+ "manual": {
55
+ "how": "Search at https://www.nsf.gov/awardsearch/ (Advanced Search), export the results as CSV, and upload the file; or open the API links in INSTRUCTIONS.md (25 awards per page) and save the JSON."
56
+ }
57
+ },
58
+ "cache": {
59
+ "mode": "run_only",
60
+ "ttl_hours": null,
61
+ "why": "Awards are amended daily; data/ is reused within a run."
62
+ },
63
+ "redistribution": {
64
+ "mode": "allowed",
65
+ "why": "NSF award data are U.S. government works in the public domain (17 U.S.C. 105). PI and program officer e-mail and phone are dropped."
66
+ },
67
+ "notices": [],
68
+ "retention": null,
69
+ "citation": "U.S. National Science Foundation, NSF Award Search ({dataset}), api.nsf.gov, retrieved {retrieved_long}.",
70
+ "audit_hooks": [],
71
+ "clarify": [
72
+ "Which dollars? fundsObligatedAmt is what NSF has obligated so far; estimatedTotalAmt is the expected total over the award's life. Default: obligated, said as such.",
73
+ "Which dates? dateStart/dateEnd filter the award date (when NSF made the award); startDate and expDate are the award's period. Default: awards made in the period asked."
74
+ ],
75
+ "formats": [
76
+ "json"
77
+ ],
78
+ "aliases": [
79
+ "NSF",
80
+ "National Science Foundation",
81
+ "NSF Award Search"
82
+ ]
83
+ }
@@ -0,0 +1,59 @@
1
+ # National Science Foundation awards (NSF Award Search API)
2
+ Depth: standard. Key: none. NSF's awards (grants, cooperative agreements, fellowships to institutions) from the
3
+ Award Search API, one row per award:
4
+ - title and abstract;
5
+ - awardee institution, location and congressional district, and the place of performance;
6
+ - PI and co-PIs;
7
+ - NSF directorate, division and program;
8
+ - amounts obligated and estimated; award, start and expiration dates.
9
+
10
+ ## When to use
11
+ - NSF funding to a university, a state or a program; NSF awards on a research topic; a researcher's NSF
12
+ awards; new awards in a period.
13
+ - Not here: NIH grants (nih); all federal grants by agency and recipient, including NSF in USAspending's
14
+ accounting (usaspending); national R&D spending statistics (NSF NCSES surveys such as HERD and Federal Funds for
15
+ R&D are not covered here); patents (uspto).
16
+
17
+ ## Endpoints
18
+ | Endpoint | Returns | Parameters (at least one filter) |
19
+ |---|---|---|
20
+ | `awards` | one row per award: `id`, `title`, `awardeeName`, `awardeeCity`, `awardeeStateCode`, `awardeeDistrictCode`, `perfStateCode`, `pdPIName`, `piFirstName`, `piLastName`, `coPDPI`, `dirAbbr`, `divAbbr`, `orgLongName`, `fundProgramName`, `fundsObligatedAmt`, `estimatedTotalAmt`, `date`, `startDate`, `expDate`, `transType`, `cfdaNumber`, `abstractText` ... | `keyword`, `awardeeName`, `awardeeStateCode`, `perfStateCode`, `pdPIName`, `fundProgramName`, `id`, and date ranges `dateStart`/`dateEnd` (award date), `startDateStart`/`startDateEnd`, `expDateStart`/`expDateEnd` (MM/DD/YYYY) |
21
+
22
+ ## Spec examples
23
+ ```json
24
+ {"description": "NSF awards mentioning quantum, made in January 2026",
25
+ "requests": [{"name": "quantum_jan26", "endpoint": "awards",
26
+ "params": {"keyword": "quantum", "dateStart": "01/01/2026", "dateEnd": "01/31/2026"}}]}
27
+ ```
28
+ ```json
29
+ {"description": "NSF awards to Vermont institutions, FY2026",
30
+ "requests": [{"name": "vt_fy26", "endpoint": "awards",
31
+ "params": {"awardeeStateCode": "VT", "dateStart": "10/01/2025", "dateEnd": "09/30/2026"}}]}
32
+ ```
33
+
34
+ ## Data format and traps
35
+ - Dollars:
36
+ - `fundsObligatedAmt` is the money obligated to date (it grows with continuing increments).
37
+ - `estimatedTotalAmt` is the expected total over the award's life.
38
+ - Name which one you use. Summing `estimatedTotalAmt` over awards made in a year gives commitments, not
39
+ spending.
40
+ - `fundsObligated` lists the obligations by fiscal year as text.
41
+ - Dates are MM/DD/YYYY, both in filters and in the rows. `dateStart`/`dateEnd` filter the award date (`date`),
42
+ not the period of performance.
43
+ - Collaborative research: each collaborating institution has its own award with the same title. Count awards, or
44
+ group by title, and say which.
45
+ - `totalCount` can exceed the awards returned: 12 counted and 11 returned for keyword "quantum", January 2026, on
46
+ 2026-11-07. Report the rows you have.
47
+ - Keyword search matches title and abstract text, including unrelated uses of the word: read the titles before
48
+ counting.
49
+ - Paging is 25 awards a page (1-based offset); requests stop at 10,000 rows. Narrow by date or state.
50
+ - People's contact fields (PI and program officer e-mail and phone) are dropped; names stay.
51
+
52
+ ## Access
53
+ No key. `fetch` uses api.nsf.gov (verified 2026-11-07). Manual: https://www.nsf.gov/awardsearch/ (Advanced Search,
54
+ export CSV), or the API links in INSTRUCTIONS.md; then `ingest`. API documentation:
55
+ https://resources.research.gov/common/webapi/awardapisearch-v1.htm.
56
+
57
+ ## Citation and terms
58
+ "U.S. National Science Foundation, NSF Award Search, <query>, api.nsf.gov, retrieved <date>." Public domain (17
59
+ U.S.C. 105).
@@ -0,0 +1,198 @@
1
+ {
2
+ "base_url": "https://revenuedata.onrr.gov",
3
+ "timeout": 240,
4
+ "endpoints": {
5
+ "fiscal_year_revenue": {
6
+ "path": "/downloads/fiscal_year_revenue.csv",
7
+ "method": "GET",
8
+ "description": "Federal and Native American natural resource revenue (royalties, rents, bonuses, other) by fiscal year, land class and category, state, county, offshore region, revenue type, lease type, commodity and product, dollars (ONRR, FY2004 on).",
9
+ "params": {
10
+ "state": {
11
+ "in": "spec",
12
+ "desc": "keep these states (full name as published, e.g. New Mexico; a list works)"
13
+ },
14
+ "from": {
15
+ "in": "spec",
16
+ "desc": "first year to keep (fiscal or calendar, as the file)"
17
+ },
18
+ "to": {
19
+ "in": "spec",
20
+ "desc": "last year to keep"
21
+ },
22
+ "commodity": {
23
+ "in": "spec",
24
+ "desc": "keep these commodities (Oil, Gas, Coal ...; as published, case-insensitive)"
25
+ },
26
+ "revenue_type": {
27
+ "in": "spec",
28
+ "desc": "keep these revenue types: Royalties, Rents, Bonus, Other revenues, Civil penalties, Inspection fees"
29
+ },
30
+ "land_class": {
31
+ "in": "spec",
32
+ "desc": "Federal or Native American"
33
+ }
34
+ },
35
+ "records": "$csv",
36
+ "paging": {
37
+ "type": "none"
38
+ },
39
+ "max_rows": 600000
40
+ },
41
+ "calendar_year_revenue": {
42
+ "path": "/downloads/calendar_year_revenue.csv",
43
+ "method": "GET",
44
+ "description": "The same revenue by calendar year (CY2003 on).",
45
+ "params": {
46
+ "state": {
47
+ "in": "spec",
48
+ "desc": "keep these states (full name as published, e.g. New Mexico; a list works)"
49
+ },
50
+ "from": {
51
+ "in": "spec",
52
+ "desc": "first year to keep (fiscal or calendar, as the file)"
53
+ },
54
+ "to": {
55
+ "in": "spec",
56
+ "desc": "last year to keep"
57
+ },
58
+ "commodity": {
59
+ "in": "spec",
60
+ "desc": "keep these commodities (Oil, Gas, Coal ...; as published, case-insensitive)"
61
+ },
62
+ "revenue_type": {
63
+ "in": "spec",
64
+ "desc": "keep these revenue types: Royalties, Rents, Bonus, Other revenues, Civil penalties, Inspection fees"
65
+ },
66
+ "land_class": {
67
+ "in": "spec",
68
+ "desc": "Federal or Native American"
69
+ }
70
+ },
71
+ "records": "$csv",
72
+ "paging": {
73
+ "type": "none"
74
+ },
75
+ "max_rows": 600000
76
+ },
77
+ "monthly_revenue": {
78
+ "path": "/downloads/monthly_revenue.csv",
79
+ "method": "GET",
80
+ "description": "The same revenue by month (January 2003 on); a 42 MB file: filter by state and years.",
81
+ "params": {
82
+ "state": {
83
+ "in": "spec",
84
+ "desc": "keep these states (full name as published, e.g. New Mexico; a list works)"
85
+ },
86
+ "from": {
87
+ "in": "spec",
88
+ "desc": "first year to keep (fiscal or calendar, as the file)"
89
+ },
90
+ "to": {
91
+ "in": "spec",
92
+ "desc": "last year to keep"
93
+ },
94
+ "commodity": {
95
+ "in": "spec",
96
+ "desc": "keep these commodities (Oil, Gas, Coal ...; as published, case-insensitive)"
97
+ },
98
+ "revenue_type": {
99
+ "in": "spec",
100
+ "desc": "keep these revenue types: Royalties, Rents, Bonus, Other revenues, Civil penalties, Inspection fees"
101
+ },
102
+ "land_class": {
103
+ "in": "spec",
104
+ "desc": "Federal or Native American"
105
+ }
106
+ },
107
+ "records": "$csv",
108
+ "paging": {
109
+ "type": "none"
110
+ },
111
+ "max_rows": 2000000
112
+ },
113
+ "fiscal_year_disbursements": {
114
+ "path": "/downloads/fiscal_year_disbursements.csv",
115
+ "method": "GET",
116
+ "description": "Where the revenue went: disbursements by fiscal year to the U.S. Treasury, states and counties, the Reclamation Fund, Land and Water Conservation Fund, Historic Preservation Fund, Native American tribes and individuals, other funds (FY2003 on).",
117
+ "params": {
118
+ "state": {
119
+ "in": "spec",
120
+ "desc": "keep these states (full name as published, e.g. New Mexico; a list works)"
121
+ },
122
+ "from": {
123
+ "in": "spec",
124
+ "desc": "first year to keep (fiscal or calendar, as the file)"
125
+ },
126
+ "to": {
127
+ "in": "spec",
128
+ "desc": "last year to keep"
129
+ },
130
+ "fund_type": {
131
+ "in": "spec",
132
+ "desc": "keep these fund types as published (State and local governments, U.S. Treasury, Reclamation Fund ...)"
133
+ }
134
+ },
135
+ "records": "$csv",
136
+ "paging": {
137
+ "type": "none"
138
+ },
139
+ "max_rows": 600000
140
+ },
141
+ "fiscal_year_production": {
142
+ "path": "/downloads/fiscal_year_production.csv",
143
+ "method": "GET",
144
+ "description": "Production volumes on federal and Native American lands and offshore by fiscal year, state, county, offshore region and product (oil bbl, gas mcf, coal tons ...).",
145
+ "params": {
146
+ "state": {
147
+ "in": "spec",
148
+ "desc": "keep these states (full name as published, e.g. New Mexico; a list works)"
149
+ },
150
+ "from": {
151
+ "in": "spec",
152
+ "desc": "first year to keep (fiscal or calendar, as the file)"
153
+ },
154
+ "to": {
155
+ "in": "spec",
156
+ "desc": "last year to keep"
157
+ },
158
+ "product": {
159
+ "in": "spec",
160
+ "desc": "keep these products as published, e.g. Oil (bbl), Gas (mcf)"
161
+ }
162
+ },
163
+ "records": "$csv",
164
+ "paging": {
165
+ "type": "none"
166
+ },
167
+ "max_rows": 600000
168
+ },
169
+ "calendar_year_production": {
170
+ "path": "/downloads/calendar_year_production.csv",
171
+ "method": "GET",
172
+ "description": "The same production by calendar year.",
173
+ "params": {
174
+ "state": {
175
+ "in": "spec",
176
+ "desc": "keep these states (full name as published, e.g. New Mexico; a list works)"
177
+ },
178
+ "from": {
179
+ "in": "spec",
180
+ "desc": "first year to keep (fiscal or calendar, as the file)"
181
+ },
182
+ "to": {
183
+ "in": "spec",
184
+ "desc": "last year to keep"
185
+ },
186
+ "product": {
187
+ "in": "spec",
188
+ "desc": "keep these products as published, e.g. Oil (bbl), Gas (mcf)"
189
+ }
190
+ },
191
+ "records": "$csv",
192
+ "paging": {
193
+ "type": "none"
194
+ },
195
+ "max_rows": 600000
196
+ }
197
+ }
198
+ }
@@ -0,0 +1,91 @@
1
+ {
2
+ "id": "onrr",
3
+ "title": "ONRR natural resources revenue data: federal and Native American royalties, rents, bonuses, disbursements and production",
4
+ "agency": "U.S. Department of the Interior, Office of Natural Resources Revenue",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "energy",
8
+ "federal revenue",
9
+ "public lands"
10
+ ],
11
+ "keywords": [
12
+ "onrr",
13
+ "office of natural resources revenue",
14
+ "natural resources revenue",
15
+ "federal royalties",
16
+ "oil and gas royalties",
17
+ "coal royalties",
18
+ "offshore leasing",
19
+ "lease bonus",
20
+ "rents",
21
+ "federal lands",
22
+ "public lands revenue",
23
+ "mineral leasing",
24
+ "disbursements to states",
25
+ "gomesa",
26
+ "reclamation fund",
27
+ "land and water conservation fund",
28
+ "production on federal lands",
29
+ "native american mineral revenue"
30
+ ],
31
+ "questions": [
32
+ "federal oil and gas royalties by state",
33
+ "revenue from federal lands in New Mexico or Wyoming",
34
+ "offshore revenue in the Gulf",
35
+ "how much mineral revenue went to a state",
36
+ "oil and gas production on federal lands by year",
37
+ "coal royalties over time"
38
+ ],
39
+ "homepage": "https://revenuedata.onrr.gov/",
40
+ "terms_url": "https://revenuedata.onrr.gov/downloads/",
41
+ "auth": {
42
+ "env": null,
43
+ "required": "none",
44
+ "placement": "none",
45
+ "signup_url": null,
46
+ "echoes_key": false
47
+ },
48
+ "limits": {
49
+ "rps": 1,
50
+ "burst": 2,
51
+ "max_rows": 2000000
52
+ },
53
+ "routes": {
54
+ "api": {
55
+ "base": "https://revenuedata.onrr.gov",
56
+ "probe": "https://revenuedata.onrr.gov/downloads/fiscal_year_disbursements.csv",
57
+ "hosts": [
58
+ "revenuedata.onrr.gov",
59
+ "revenuedata.doi.gov"
60
+ ]
61
+ },
62
+ "manual": {
63
+ "how": "Open https://revenuedata.onrr.gov/downloads/ (Revenue, Disbursements or Production, then 'Downloads and documentation'), download the CSV and upload it with ingest."
64
+ }
65
+ },
66
+ "cache": {
67
+ "mode": "run_only",
68
+ "ttl_hours": null,
69
+ "why": "Files are refreshed monthly; data/ is reused within a run."
70
+ },
71
+ "redistribution": {
72
+ "mode": "allowed",
73
+ "why": "ONRR data are U.S. government works in the public domain (17 U.S.C. 105)."
74
+ },
75
+ "notices": [],
76
+ "retention": null,
77
+ "citation": "U.S. Department of the Interior, Office of Natural Resources Revenue, {dataset}, revenuedata.onrr.gov, retrieved {retrieved_long}.",
78
+ "audit_hooks": [],
79
+ "clarify": [
80
+ "Revenue or disbursements? Revenue is what companies paid ONRR (by where the resource is); disbursements are what ONRR paid out to the Treasury, states, counties and funds. Default: revenue for 'how much came from', disbursements for 'how much a state got'.",
81
+ "Fiscal or calendar year? Federal fiscal years run October-September. Default: fiscal year, said as such."
82
+ ],
83
+ "formats": [
84
+ "csv"
85
+ ],
86
+ "aliases": [
87
+ "ONRR",
88
+ "Natural Resources Revenue Data",
89
+ "revenuedata.doi.gov"
90
+ ]
91
+ }
@@ -0,0 +1,55 @@
1
+ # ONRR natural resources revenue data: federal and Native American royalties, rents, bonuses, disbursements and production
2
+ Depth: standard. Key: none. The Office of Natural Resources Revenue's open data (Natural Resources Revenue Data,
3
+ revenuedata.onrr.gov), as its CSV downloads:
4
+ - revenue companies paid for extracting oil, gas, coal, minerals and renewable energy on federal onshore and
5
+ offshore lands and Native American lands (royalties, rents, bonuses, other revenues), by year or month;
6
+ - disbursements of that money to the U.S. Treasury, states and counties, and federal funds;
7
+ - production volumes on those lands.
8
+
9
+ ## When to use
10
+ - Federal royalties and other mineral revenue by state, county, offshore region, commodity or year; offshore
11
+ lease bonuses; how much a state received (disbursements); oil, gas and coal produced on federal lands.
12
+ - Not here: total U.S. or state production and prices on all lands (eia); federal receipts in the budget
13
+ (treasury MTS, omb); severance taxes states levy themselves (census government finances).
14
+
15
+ ## Endpoints
16
+ All take `state` (full name), `from`/`to` (years).
17
+
18
+ | Endpoint | Columns | More filters |
19
+ |---|---|---|
20
+ | `fiscal_year_revenue`, `calendar_year_revenue`, `monthly_revenue` (`Date` MM/DD/YYYY; 42 MB) | Fiscal Year (or Calendar Year, Date), Land Class, Land Category, State, County, FIPS Code, Offshore Region, Revenue Type, Mineral Lease Type, Commodity, Product, Revenue | `commodity`, `revenue_type`, `land_class` |
21
+ | `fiscal_year_disbursements` | Fiscal Year, Fund Type, Source, State, County, Disbursement | `fund_type` |
22
+ | `fiscal_year_production`, `calendar_year_production` | Fiscal Year (or Calendar Year), Land Class, Land Category, State, County, FIPS Code, Offshore Region, Product, Volume | `product` |
23
+
24
+ ## Spec examples
25
+ ```json
26
+ {"description": "Federal mineral revenue in New Mexico by type and commodity, FY2025",
27
+ "requests": [{"name": "nm_fy2025", "endpoint": "fiscal_year_revenue", "params": {"state": "New Mexico", "from": "2025", "to": "2025"}}]}
28
+ ```
29
+ ```json
30
+ {"description": "Disbursements to Wyoming, FY2020-2025",
31
+ "requests": [{"name": "wy_disb", "endpoint": "fiscal_year_disbursements", "params": {"state": "Wyoming", "from": "2020", "to": "2025"}}]}
32
+ ```
33
+
34
+ ## Data format and traps
35
+ - Revenue is in dollars, as text. Rows can be negative (adjustments and refunds: 3,486 negative rows in the
36
+ fiscal-year file of 2026-11-07). Sum them with the rest; never drop them.
37
+ - Revenue by state is where the resource is (onshore federal land). Offshore revenue has no state (`State`
38
+ empty, `Offshore Region` = Gulf of America, Pacific, Alaska, Atlantic). Native American revenue (`Land Class`
39
+ Native American) has no state or county in these files. A state total from the State column
40
+ is federal onshore revenue only: say so.
41
+ - Revenue and disbursements are different money flows and years: disbursements follow collection, and offshore
42
+ revenue reaches states under their own formulas. Never subtract one from the other.
43
+ - `Product` carries the unit in production files (Oil (bbl), Gas (mcf), Coal (tons) ...): never add volumes
44
+ across products.
45
+ - The current fiscal year is partial. Fiscal years run October-September. Revenue starts FY2004 (CY2003);
46
+ older years are in separate historical files (not covered).
47
+
48
+ ## Access
49
+ No key. `fetch` reads revenuedata.onrr.gov/downloads/<file>.csv (revenuedata.doi.gov redirects there; verified
50
+ 2026-11-07; up to 42 MB) and filters it. Manual: the Downloads page, then `ingest`. The site's documentation
51
+ pages under /downloads/ describe each field.
52
+
53
+ ## Citation and terms
54
+ "U.S. Department of the Interior, Office of Natural Resources Revenue, Natural Resources Revenue Data, <file>,
55
+ revenuedata.onrr.gov, retrieved <date>." Public domain (17 U.S.C. 105).
package/packs/port.json CHANGED
@@ -14,6 +14,11 @@
14
14
  "fetch.py"
15
15
  ]
16
16
  },
17
+ "bjs": {
18
+ "python": [
19
+ "adapter.py"
20
+ ]
21
+ },
17
22
  "bls": {
18
23
  "python": [
19
24
  "fetch.py"
@@ -24,6 +29,16 @@
24
29
  "adapter.py"
25
30
  ]
26
31
  },
32
+ "cbp": {
33
+ "python": [
34
+ "adapter.py"
35
+ ]
36
+ },
37
+ "cdc-wonder": {
38
+ "python": [
39
+ "adapter.py"
40
+ ]
41
+ },
27
42
  "census": {
28
43
  "python": [
29
44
  "adapter.py"
@@ -54,6 +69,11 @@
54
69
  "adapter.py"
55
70
  ]
56
71
  },
72
+ "cpsc": {
73
+ "python": [
74
+ "adapter.py"
75
+ ]
76
+ },
57
77
  "dhs-ohss": {
58
78
  "python": [
59
79
  "adapter.py"
@@ -119,6 +139,16 @@
119
139
  "adapter.py"
120
140
  ]
121
141
  },
142
+ "fhwa": {
143
+ "python": [
144
+ "adapter.py"
145
+ ]
146
+ },
147
+ "foreign-assistance": {
148
+ "python": [
149
+ "adapter.py"
150
+ ]
151
+ },
122
152
  "fred": {
123
153
  "python": [
124
154
  "fetch.py"
@@ -144,6 +174,11 @@
144
174
  "adapter.py"
145
175
  ]
146
176
  },
177
+ "hud-ahar": {
178
+ "python": [
179
+ "adapter.py"
180
+ ]
181
+ },
147
182
  "ipums": {
148
183
  "python": [
149
184
  "fetch.py"
@@ -159,6 +194,11 @@
159
194
  "adapter.py"
160
195
  ]
161
196
  },
197
+ "nces": {
198
+ "python": [
199
+ "adapter.py"
200
+ ]
201
+ },
162
202
  "nhtsa": {
163
203
  "python": [
164
204
  "adapter.py"
@@ -179,6 +219,11 @@
179
219
  "adapter.py"
180
220
  ]
181
221
  },
222
+ "nsf": {
223
+ "python": [
224
+ "adapter.py"
225
+ ]
226
+ },
182
227
  "nws": {
183
228
  "python": [
184
229
  "adapter.py"
@@ -189,6 +234,11 @@
189
234
  "adapter.py"
190
235
  ]
191
236
  },
237
+ "onrr": {
238
+ "python": [
239
+ "adapter.py"
240
+ ]
241
+ },
192
242
  "open-payments": {
193
243
  "python": [
194
244
  "adapter.py"
@@ -214,6 +264,11 @@
214
264
  "adapter.py"
215
265
  ]
216
266
  },
267
+ "sba": {
268
+ "python": [
269
+ "adapter.py"
270
+ ]
271
+ },
217
272
  "sec": {
218
273
  "python": [
219
274
  "adapter.py"
@@ -234,6 +289,11 @@
234
289
  "fetch.py"
235
290
  ]
236
291
  },
292
+ "treasury-tic": {
293
+ "python": [
294
+ "adapter.py"
295
+ ]
296
+ },
237
297
  "treasury-yields": {
238
298
  "python": [
239
299
  "adapter.py"
@@ -244,6 +304,11 @@
244
304
  "adapter.py"
245
305
  ]
246
306
  },
307
+ "uscourts": {
308
+ "python": [
309
+ "adapter.py"
310
+ ]
311
+ },
247
312
  "usda-fna": {
248
313
  "python": [
249
314
  "adapter.py"
@@ -0,0 +1,34 @@
1
+ {
2
+ "base_url": "https://data.sba.gov",
3
+ "timeout": 600,
4
+ "catalog_path": "/data.json",
5
+ "endpoints": {
6
+ "list_files": {
7
+ "path": "/data.json",
8
+ "method": "GET",
9
+ "description": "The loan data files SBA currently publishes (from data.sba.gov's catalog): 7(a) and 504 FOIA loan-level CSVs (file names carry the as-of date), activity reports, disaster loan workbooks. One row per file with the path for the foia request.",
10
+ "params": {
11
+ "search": {"in": "spec", "desc": "keep files whose dataset or file title contains this (e.g. FOIA, 504, Disaster)"}
12
+ },
13
+ "records": "",
14
+ "paging": {"type": "none"},
15
+ "max_rows": 5000
16
+ },
17
+ "foia": {
18
+ "path": "/sites/default/files/{file}.csv",
19
+ "method": "GET",
20
+ "description": "SBA 7(a) or 504 loan-level FOIA data: one row per approved loan with borrower, lender (or CDC), amount, approval date and fiscal year, NAICS industry, project state and county, congressional district, loan status, charge-off. Read streaming and filtered: give at least one of state, fiscal_year, from, naics.",
21
+ "params": {
22
+ "file": {"in": "path", "raw": true, "required": true, "desc": "the file's path under /sites/default/files without .csv, from list_files, e.g. uploaded_resources/FOIA_504_FY2010_Present_asof_260930"},
23
+ "state": {"in": "spec", "desc": "keep loans with this ProjectState (two letters; a list works)"},
24
+ "fiscal_year": {"in": "spec", "desc": "keep these ApprovalFY values (a year or a list)"},
25
+ "from": {"in": "spec", "desc": "first ApprovalFY to keep"},
26
+ "to": {"in": "spec", "desc": "last ApprovalFY to keep"},
27
+ "naics": {"in": "spec", "desc": "keep NaicsCode values starting with these digits (e.g. 72; a list works)"}
28
+ },
29
+ "records": "$csv",
30
+ "paging": {"type": "none"},
31
+ "max_rows": 1000000
32
+ }
33
+ }
34
+ }