data-analyst-mcp 0.3.0 → 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 (292) hide show
  1. package/README.md +286 -262
  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 +10 -1
  89. package/dist/report/method_audit.js.map +1 -1
  90. package/dist/report/scan_secrets.d.ts +4 -1
  91. package/dist/report/scan_secrets.js +38 -18
  92. package/dist/report/scan_secrets.js.map +1 -1
  93. package/dist/server.d.ts +3 -1
  94. package/dist/server.js +46 -13
  95. package/dist/server.js.map +1 -1
  96. package/dist/tools.js +27 -6
  97. package/dist/tools.js.map +1 -1
  98. package/guide/WORKFLOW.md +134 -134
  99. package/guide/assets/disclaimer.txt +1 -1
  100. package/guide/assets/download_data.ps1 +164 -162
  101. package/guide/assets/download_data.sh +8 -2
  102. package/guide/assets/report_template.html +597 -597
  103. package/guide/references/routing.md +198 -171
  104. package/guide/references/style_guide.md +398 -398
  105. package/package.json +56 -56
  106. package/packs/acf/endpoints.json +114 -114
  107. package/packs/acf/policy.json +104 -104
  108. package/packs/actuaries/endpoints.json +82 -82
  109. package/packs/actuaries/policy.json +109 -109
  110. package/packs/bea/assets/download_bea.ps1 +182 -182
  111. package/packs/bea/docs/bea_api.md +461 -461
  112. package/packs/bea/docs/datasets.md +157 -157
  113. package/packs/bea/docs/report_patterns.md +112 -112
  114. package/packs/bea/policy.json +170 -170
  115. package/packs/bea/source.md +152 -152
  116. package/packs/bjs/endpoints.json +150 -0
  117. package/packs/bjs/policy.json +114 -0
  118. package/packs/bjs/source.md +98 -0
  119. package/packs/bls/assets/download_bls.ps1 +152 -152
  120. package/packs/bls/docs/analysis_patterns.md +108 -108
  121. package/packs/bls/docs/bls_api.md +73 -73
  122. package/packs/bls/docs/series_ids.md +149 -149
  123. package/packs/bls/policy.json +238 -238
  124. package/packs/bts/endpoints.json +346 -346
  125. package/packs/bts/policy.json +94 -94
  126. package/packs/cbp/endpoints.json +31 -0
  127. package/packs/cbp/policy.json +85 -0
  128. package/packs/cbp/source.md +57 -0
  129. package/packs/cdc/endpoints.json +197 -197
  130. package/packs/cdc/policy.json +83 -83
  131. package/packs/cdc/source.md +1 -1
  132. package/packs/cdc-wonder/endpoints.json +26 -0
  133. package/packs/cdc-wonder/policy.json +84 -0
  134. package/packs/cdc-wonder/source.md +53 -0
  135. package/packs/census/endpoints.json +99 -99
  136. package/packs/cfpb/endpoints.json +326 -326
  137. package/packs/cfpb/policy.json +119 -119
  138. package/packs/clinical-trials/endpoints.json +166 -166
  139. package/packs/clinical-trials/policy.json +84 -84
  140. package/packs/cms/endpoints.json +69 -69
  141. package/packs/cms/policy.json +96 -96
  142. package/packs/college-scorecard/endpoints.json +252 -252
  143. package/packs/college-scorecard/policy.json +106 -106
  144. package/packs/college-scorecard/source.md +1 -1
  145. package/packs/congress/endpoints.json +1701 -1701
  146. package/packs/congress/policy.json +117 -117
  147. package/packs/cpsc/endpoints.json +91 -0
  148. package/packs/cpsc/policy.json +91 -0
  149. package/packs/cpsc/source.md +76 -0
  150. package/packs/dhs-ohss/endpoints.json +66 -66
  151. package/packs/dhs-ohss/policy.json +107 -107
  152. package/packs/dhs-ohss/source.md +1 -1
  153. package/packs/doj-news/endpoints.json +59 -59
  154. package/packs/doj-news/policy.json +96 -96
  155. package/packs/doj-news/source.md +1 -1
  156. package/packs/dol/endpoints.json +817 -817
  157. package/packs/dol/policy.json +135 -135
  158. package/packs/eia/endpoints.json +717 -717
  159. package/packs/eia/policy.json +112 -112
  160. package/packs/epa/endpoints.json +291 -291
  161. package/packs/epa/policy.json +99 -99
  162. package/packs/epa-aqs/endpoints.json +173 -173
  163. package/packs/epa-aqs/policy.json +96 -96
  164. package/packs/fbi/endpoints.json +1841 -1841
  165. package/packs/fbi/policy.json +118 -118
  166. package/packs/fbi/source.md +3 -3
  167. package/packs/fda/endpoints.json +237 -237
  168. package/packs/fda/policy.json +121 -121
  169. package/packs/fdic/endpoints.json +416 -416
  170. package/packs/fdic/policy.json +83 -83
  171. package/packs/fec/endpoints.json +707 -707
  172. package/packs/fec/policy.json +93 -93
  173. package/packs/fed-board/endpoints.json +89 -89
  174. package/packs/fed-board/policy.json +136 -136
  175. package/packs/federal-register/endpoints.json +143 -143
  176. package/packs/federal-register/policy.json +86 -86
  177. package/packs/fema/endpoints.json +645 -645
  178. package/packs/fema/policy.json +103 -103
  179. package/packs/fhfa/endpoints.json +105 -105
  180. package/packs/fhfa/policy.json +109 -109
  181. package/packs/fhwa/endpoints.json +48 -0
  182. package/packs/fhwa/policy.json +91 -0
  183. package/packs/fhwa/source.md +59 -0
  184. package/packs/foreign-assistance/endpoints.json +166 -0
  185. package/packs/foreign-assistance/policy.json +80 -0
  186. package/packs/foreign-assistance/source.md +76 -0
  187. package/packs/fred/assets/download_fred.ps1 +122 -122
  188. package/packs/fred/docs/analysis_patterns.md +124 -124
  189. package/packs/fred/docs/fred_api.md +94 -94
  190. package/packs/fred/docs/series.md +188 -188
  191. package/packs/fred/policy.json +253 -253
  192. package/packs/fsa/endpoints.json +150 -150
  193. package/packs/fsa/policy.json +99 -99
  194. package/packs/fsa/source.md +1 -1
  195. package/packs/govinfo/endpoints.json +519 -519
  196. package/packs/gsa-calc/endpoints.json +93 -93
  197. package/packs/gsa-calc/policy.json +97 -97
  198. package/packs/hud/endpoints.json +146 -146
  199. package/packs/hud/policy.json +84 -84
  200. package/packs/hud/source.md +1 -1
  201. package/packs/hud-ahar/endpoints.json +92 -0
  202. package/packs/hud-ahar/policy.json +88 -0
  203. package/packs/hud-ahar/source.md +72 -0
  204. package/packs/ipums/docs/report_patterns.md +117 -117
  205. package/packs/irs-soi/endpoints.json +114 -114
  206. package/packs/irs-soi/policy.json +107 -107
  207. package/packs/medicaid/endpoints.json +412 -412
  208. package/packs/medicaid/policy.json +108 -108
  209. package/packs/naep/endpoints.json +217 -217
  210. package/packs/naep/policy.json +100 -100
  211. package/packs/naep/source.md +1 -1
  212. package/packs/nces/endpoints.json +101 -0
  213. package/packs/nces/policy.json +99 -0
  214. package/packs/nces/source.md +75 -0
  215. package/packs/nhtsa/endpoints.json +132 -132
  216. package/packs/nhtsa/policy.json +93 -93
  217. package/packs/nhtsa/source.md +1 -1
  218. package/packs/nih/endpoints.json +452 -452
  219. package/packs/nih/policy.json +86 -86
  220. package/packs/noaa/endpoints.json +431 -431
  221. package/packs/noaa/policy.json +95 -95
  222. package/packs/nrel/endpoints.json +327 -327
  223. package/packs/nrel/policy.json +96 -96
  224. package/packs/nsf/endpoints.json +33 -0
  225. package/packs/nsf/policy.json +83 -0
  226. package/packs/nsf/source.md +59 -0
  227. package/packs/nws/endpoints.json +271 -271
  228. package/packs/nws/policy.json +82 -82
  229. package/packs/nyfed/endpoints.json +80 -80
  230. package/packs/nyfed/policy.json +92 -92
  231. package/packs/omb/endpoints.json +460 -460
  232. package/packs/omb/policy.json +106 -106
  233. package/packs/onrr/endpoints.json +198 -0
  234. package/packs/onrr/policy.json +91 -0
  235. package/packs/onrr/source.md +55 -0
  236. package/packs/open-payments/endpoints.json +297 -297
  237. package/packs/open-payments/policy.json +101 -101
  238. package/packs/opm/assets/download_opm.ps1 +125 -125
  239. package/packs/opm/docs/fields.md +184 -184
  240. package/packs/opm/docs/opm_api.md +71 -71
  241. package/packs/opm/docs/report_patterns.md +83 -83
  242. package/packs/opm/lib/data_dictionary.csv +73 -73
  243. package/packs/pbgc/endpoints.json +483 -483
  244. package/packs/pbgc/policy.json +94 -94
  245. package/packs/philfed/endpoints.json +85 -85
  246. package/packs/philfed/policy.json +94 -94
  247. package/packs/port.json +65 -0
  248. package/packs/regulations/endpoints.json +287 -287
  249. package/packs/regulations/policy.json +86 -86
  250. package/packs/sba/endpoints.json +34 -0
  251. package/packs/sba/policy.json +86 -0
  252. package/packs/sba/source.md +60 -0
  253. package/packs/sec/endpoints.json +236 -236
  254. package/packs/sec/policy.json +86 -86
  255. package/packs/senate-lobbying/endpoints.json +553 -553
  256. package/packs/senate-lobbying/policy.json +99 -99
  257. package/packs/snapqc/endpoints.json +1426 -1426
  258. package/packs/snapqc/policy.json +92 -92
  259. package/packs/treasury/catalog.json +2267 -2267
  260. package/packs/treasury/docs/api_guide.md +245 -245
  261. package/packs/treasury/docs/datasets.md +56 -56
  262. package/packs/treasury/docs/report_patterns.md +126 -126
  263. package/packs/treasury/policy.json +159 -159
  264. package/packs/treasury/source.md +170 -165
  265. package/packs/treasury-tic/endpoints.json +77 -0
  266. package/packs/treasury-tic/policy.json +89 -0
  267. package/packs/treasury-tic/source.md +80 -0
  268. package/packs/treasury-yields/endpoints.json +226 -226
  269. package/packs/treasury-yields/policy.json +86 -86
  270. package/packs/usaspending/endpoints.json +1315 -1315
  271. package/packs/usaspending/policy.json +109 -109
  272. package/packs/uscourts/endpoints.json +22 -0
  273. package/packs/uscourts/policy.json +87 -0
  274. package/packs/uscourts/source.md +56 -0
  275. package/packs/usda-fna/policy.json +133 -133
  276. package/packs/usda-fooddata/endpoints.json +180 -180
  277. package/packs/usda-fooddata/policy.json +94 -94
  278. package/packs/usda-nass/endpoints.json +323 -323
  279. package/packs/usda-nass/policy.json +95 -95
  280. package/packs/usda-outlook/endpoints.json +86 -86
  281. package/packs/usda-outlook/policy.json +109 -109
  282. package/packs/usgs/endpoints.json +313 -313
  283. package/packs/usgs/policy.json +95 -95
  284. package/packs/usitc/endpoints.json +74 -74
  285. package/packs/usitc/policy.json +111 -111
  286. package/packs/uspto/endpoints.json +141 -141
  287. package/packs/uspto/policy.json +95 -95
  288. package/packs/uspto/source.md +1 -1
  289. package/packs/va/endpoints.json +414 -414
  290. package/packs/va/policy.json +101 -101
  291. package/packs/world-bank/endpoints.json +122 -122
  292. package/packs/world-bank/policy.json +101 -101
@@ -1,118 +1,118 @@
1
- {
2
- "id": "fbi",
3
- "title": "FBI Crime Data Explorer (UCR, NIBRS, hate crime, arrests, police employees)",
4
- "agency": "Federal Bureau of Investigation, Criminal Justice Information Services Division (U.S. Department of Justice)",
5
- "depth": "standard",
6
- "domains": [
7
- "crime",
8
- "justice",
9
- "public safety",
10
- "policing"
11
- ],
12
- "keywords": [
13
- "crime",
14
- "crime rate",
15
- "violent crime",
16
- "property crime",
17
- "murder",
18
- "homicide",
19
- "robbery",
20
- "assault",
21
- "burglary",
22
- "larceny",
23
- "theft",
24
- "motor vehicle theft",
25
- "arson",
26
- "rape",
27
- "arrest",
28
- "arrests",
29
- "hate crime",
30
- "bias",
31
- "nibrs",
32
- "ucr",
33
- "srs",
34
- "police",
35
- "law enforcement",
36
- "officers",
37
- "clearance",
38
- "fbi",
39
- "cde",
40
- "drug arrests",
41
- "supplementary homicide"
42
- ],
43
- "questions": [
44
- "violent crime rate trend in the United States",
45
- "murders in a state by year",
46
- "hate crimes by bias type",
47
- "drug arrests by year",
48
- "number of police officers per 1,000 people",
49
- "crime clearance rates",
50
- "homicide victims by weapon"
51
- ],
52
- "homepage": "https://cde.ucr.cjis.gov/",
53
- "terms_url": "https://www.fbi.gov/how-we-can-help-you/more-fbi-services-and-information/ucr",
54
- "auth": {
55
- "env": "DATA_GOV_API_KEY",
56
- "required": "optional",
57
- "placement": "query",
58
- "param": "API_KEY",
59
- "home": "data-gov",
60
- "signup_url": "https://api.data.gov/signup/",
61
- "echoes_key": false,
62
- "key_only": [
63
- "more than 30 requests an hour or 50 a day (DEMO_KEY limits per IP address; a personal key allows 1,000 an hour)"
64
- ],
65
- "demo_key": "DEMO_KEY"
66
- },
67
- "limits": {
68
- "rps": 1,
69
- "burst": 3,
70
- "daily_quota": null,
71
- "max_rows": 100000
72
- },
73
- "routes": {
74
- "api": {
75
- "base": "https://api.usa.gov/crime/fbi/cde",
76
- "probe": "https://api.usa.gov/crime/fbi/cde/summarized/national/V?from=01-2022&to=12-2022",
77
- "hosts": [
78
- "api.usa.gov"
79
- ]
80
- },
81
- "manual": {
82
- "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser (each carries api.data.gov's public DEMO_KEY; replace it with your own free key if it answers OVER_RATE_LIMIT), save the JSON under the name shown, and upload the files. Without the links: the Crime Data Explorer at https://cde.ucr.cjis.gov/ (Explorer > choose crime, location and years > download CSV) or its Documents & Downloads page for full NIBRS and SRS files."
83
- }
84
- },
85
- "cache": {
86
- "mode": "run_only",
87
- "ttl_hours": null,
88
- "why": "Small chart queries; CDE refreshes monthly and revises past years, so data/ is reused only within a run."
89
- },
90
- "redistribution": {
91
- "mode": "allowed",
92
- "why": "Uniform Crime Reporting data published by the FBI are U.S. government works in the public domain (17 U.S.C. 105); attribute the FBI UCR Program and do not imply endorsement."
93
- },
94
- "notices": [],
95
- "retention": null,
96
- "citation": "Federal Bureau of Investigation, Crime Data Explorer, {dataset}, api.usa.gov/crime/fbi/cde, retrieved {retrieved_long}.",
97
- "audit_hooks": [
98
- {
99
- "id": "fbi_participation",
100
- "kind": "require_text",
101
- "any": [
102
- "coverage",
103
- "participat",
104
- "reporting agencies",
105
- "nibrs transition"
106
- ],
107
- "why": "Counts depend on which agencies reported; 2021 coverage fell to about 77% of the population during the NIBRS transition, so a report must state coverage or participation."
108
- }
109
- ],
110
- "clarify": [
111
- "Counts or rates? Counts depend on how many agencies reported (2021 coverage fell to about 77% of the population); compare years with rates per 100,000 and state the coverage.",
112
- "Which years? 2021 is not comparable with earlier and later years at the state and national level because of the NIBRS transition; say whether to include or flag it.",
113
- "Reported offenses (agency submissions, this pack) or the FBI's published national estimates (Crime in the Nation tables; not fetched by this pack)?"
114
- ],
115
- "formats": [
116
- "json"
117
- ]
118
- }
1
+ {
2
+ "id": "fbi",
3
+ "title": "FBI Crime Data Explorer (UCR, NIBRS, hate crime, arrests, police employees)",
4
+ "agency": "Federal Bureau of Investigation, Criminal Justice Information Services Division (U.S. Department of Justice)",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "crime",
8
+ "justice",
9
+ "public safety",
10
+ "policing"
11
+ ],
12
+ "keywords": [
13
+ "crime",
14
+ "crime rate",
15
+ "violent crime",
16
+ "property crime",
17
+ "murder",
18
+ "homicide",
19
+ "robbery",
20
+ "assault",
21
+ "burglary",
22
+ "larceny",
23
+ "theft",
24
+ "motor vehicle theft",
25
+ "arson",
26
+ "rape",
27
+ "arrest",
28
+ "arrests",
29
+ "hate crime",
30
+ "bias",
31
+ "nibrs",
32
+ "ucr",
33
+ "srs",
34
+ "police",
35
+ "law enforcement",
36
+ "officers",
37
+ "clearance",
38
+ "fbi",
39
+ "cde",
40
+ "drug arrests",
41
+ "supplementary homicide"
42
+ ],
43
+ "questions": [
44
+ "violent crime rate trend in the United States",
45
+ "murders in a state by year",
46
+ "hate crimes by bias type",
47
+ "drug arrests by year",
48
+ "number of police officers per 1,000 people",
49
+ "crime clearance rates",
50
+ "homicide victims by weapon"
51
+ ],
52
+ "homepage": "https://cde.ucr.cjis.gov/",
53
+ "terms_url": "https://www.fbi.gov/how-we-can-help-you/more-fbi-services-and-information/ucr",
54
+ "auth": {
55
+ "env": "DATA_GOV_API_KEY",
56
+ "required": "optional",
57
+ "placement": "query",
58
+ "param": "API_KEY",
59
+ "home": "data-gov",
60
+ "signup_url": "https://api.data.gov/signup/",
61
+ "echoes_key": false,
62
+ "key_only": [
63
+ "more than 30 requests an hour or 50 a day (DEMO_KEY limits per IP address; a personal key allows 1,000 an hour)"
64
+ ],
65
+ "demo_key": "DEMO_KEY"
66
+ },
67
+ "limits": {
68
+ "rps": 1,
69
+ "burst": 3,
70
+ "daily_quota": null,
71
+ "max_rows": 100000
72
+ },
73
+ "routes": {
74
+ "api": {
75
+ "base": "https://api.usa.gov/crime/fbi/cde",
76
+ "probe": "https://api.usa.gov/crime/fbi/cde/summarized/national/V?from=01-2022&to=12-2022",
77
+ "hosts": [
78
+ "api.usa.gov"
79
+ ]
80
+ },
81
+ "manual": {
82
+ "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser (each carries api.data.gov's public DEMO_KEY; replace it with your own free key if it answers OVER_RATE_LIMIT), save the JSON under the name shown, and upload the files. Without the links: the Crime Data Explorer at https://cde.ucr.cjis.gov/ (Explorer > choose crime, location and years > download CSV) or its Documents & Downloads page for full NIBRS and SRS files."
83
+ }
84
+ },
85
+ "cache": {
86
+ "mode": "run_only",
87
+ "ttl_hours": null,
88
+ "why": "Small chart queries; CDE refreshes monthly and revises past years, so data/ is reused only within a run."
89
+ },
90
+ "redistribution": {
91
+ "mode": "allowed",
92
+ "why": "Uniform Crime Reporting data published by the FBI are U.S. government works in the public domain (17 U.S.C. 105); attribute the FBI UCR Program and do not imply endorsement."
93
+ },
94
+ "notices": [],
95
+ "retention": null,
96
+ "citation": "Federal Bureau of Investigation, Crime Data Explorer, {dataset}, api.usa.gov/crime/fbi/cde, retrieved {retrieved_long}.",
97
+ "audit_hooks": [
98
+ {
99
+ "id": "fbi_participation",
100
+ "kind": "require_text",
101
+ "any": [
102
+ "coverage",
103
+ "participat",
104
+ "reporting agencies",
105
+ "nibrs transition"
106
+ ],
107
+ "why": "Counts depend on which agencies reported; 2021 coverage fell to about 77% of the population during the NIBRS transition, so a report must state coverage or participation."
108
+ }
109
+ ],
110
+ "clarify": [
111
+ "Counts or rates? Counts depend on how many agencies reported (2021 coverage fell to about 77% of the population); compare years with rates per 100,000 and state the coverage.",
112
+ "Which years? 2021 is not comparable with earlier and later years at the state and national level because of the NIBRS transition; say whether to include or flag it.",
113
+ "Reported offenses (agency submissions, this pack) or the FBI's published national estimates (Crime in the Nation tables; not fetched by this pack)?"
114
+ ],
115
+ "formats": [
116
+ "json"
117
+ ]
118
+ }
@@ -6,9 +6,9 @@ data from the FBI Uniform Crime Reporting (UCR) Program, served by the Crime Dat
6
6
  - Offenses and clearances by month (violent, property, homicide, robbery ...), national, state or agency;
7
7
  arrests; NIBRS incident breakdowns (victim, offender, location, weapon); Supplementary Homicide Reports;
8
8
  hate crimes by bias; law enforcement employees; law enforcement suicide data (LESDC).
9
- - Not here: victimization surveys including crimes not reported to police (BJS NCVS, not covered), prisons
10
- and sentencing (BJS / U.S. Sentencing Commission), federal prosecutions and DOJ announcements (doj-news,
11
- which is text), the FBI's annual "Crime in the Nation" estimate tables (published reports).
9
+ - Not here: victimization surveys including crimes not reported to police (bjs: NCVS), prisons,
10
+ jails, probation and parole (bjs), federal court caseloads (uscourts), sentencing (U.S. Sentencing
11
+ Commission, not covered), federal prosecutions and DOJ announcements (doj-news, which is text), the FBI's annual "Crime in the Nation" estimate tables (published reports).
12
12
  - Not wrapped by this pack, though the CDE API has them (verified 2026-10): NIBRS estimates with lower and
13
13
  upper bounds (`/nibrs-estimation/national|region|state/<numeric offense ID>?year=`, years 2021 and 2022
14
14
  only, other years HTTP 400; the offense and state IDs are numeric codes not documented here) and use of