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,646 +1,646 @@
1
- {
2
- "base_url": "https://www.fema.gov/api/open",
3
- "endpoints": {
4
- "disaster_declarations": {
5
- "path": "/v2/DisasterDeclarationsSummaries",
6
- "method": "GET",
7
- "description": "Disaster declarations since 1953 (DR major disaster, EM emergency, FM fire management): one row per declared county/area (v2/DisasterDeclarationsSummaries).",
8
- "params": {
9
- "$filter": {
10
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
11
- },
12
- "$select": {
13
- "desc": "comma-separated fields"
14
- },
15
- "$orderby": {
16
- "desc": "e.g. declarationDate desc; set it for stable paging"
17
- },
18
- "$count": {
19
- "desc": "true adds metadata.count (the total matching rows) to the first page"
20
- }
21
- },
22
- "records": "DisasterDeclarationsSummaries",
23
- "total": "metadata.count",
24
- "paging": {
25
- "type": "offset",
26
- "limit_param": "$top",
27
- "offset_param": "$skip",
28
- "size": 10000
29
- },
30
- "max_rows": 200000,
31
- "missing": [
32
- ""
33
- ],
34
- "flatten": true,
35
- "defaults": {
36
- "$orderby": "id"
37
- }
38
- },
39
- "housing_owners": {
40
- "path": "/v2/HousingAssistanceOwners",
41
- "method": "GET",
42
- "description": "Individuals and Households Program housing assistance for homeowners, by disaster, county, city and ZIP (v2/HousingAssistanceOwners).",
43
- "params": {
44
- "$filter": {
45
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
46
- },
47
- "$select": {
48
- "desc": "comma-separated fields"
49
- },
50
- "$orderby": {
51
- "desc": "e.g. declarationDate desc; set it for stable paging"
52
- },
53
- "$count": {
54
- "desc": "true adds metadata.count (the total matching rows) to the first page"
55
- }
56
- },
57
- "records": "HousingAssistanceOwners",
58
- "total": "metadata.count",
59
- "paging": {
60
- "type": "offset",
61
- "limit_param": "$top",
62
- "offset_param": "$skip",
63
- "size": 10000
64
- },
65
- "max_rows": 200000,
66
- "missing": [
67
- ""
68
- ],
69
- "flatten": true,
70
- "defaults": {
71
- "$orderby": "id"
72
- }
73
- },
74
- "housing_renters": {
75
- "path": "/v2/HousingAssistanceRenters",
76
- "method": "GET",
77
- "description": "IHP housing assistance for renters, by disaster, county, city and ZIP (v2/HousingAssistanceRenters).",
78
- "params": {
79
- "$filter": {
80
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
81
- },
82
- "$select": {
83
- "desc": "comma-separated fields"
84
- },
85
- "$orderby": {
86
- "desc": "e.g. declarationDate desc; set it for stable paging"
87
- },
88
- "$count": {
89
- "desc": "true adds metadata.count (the total matching rows) to the first page"
90
- }
91
- },
92
- "records": "HousingAssistanceRenters",
93
- "total": "metadata.count",
94
- "paging": {
95
- "type": "offset",
96
- "limit_param": "$top",
97
- "offset_param": "$skip",
98
- "size": 10000
99
- },
100
- "max_rows": 200000,
101
- "missing": [
102
- ""
103
- ],
104
- "flatten": true,
105
- "defaults": {
106
- "$orderby": "id"
107
- }
108
- },
109
- "public_assistance": {
110
- "path": "/v2/PublicAssistanceGrantAwardActivities",
111
- "method": "GET",
112
- "description": "Public Assistance grant award activities: applicant, county, damage category, federal share obligated (v2/PublicAssistanceGrantAwardActivities).",
113
- "params": {
114
- "$filter": {
115
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
116
- },
117
- "$select": {
118
- "desc": "comma-separated fields"
119
- },
120
- "$orderby": {
121
- "desc": "e.g. declarationDate desc; set it for stable paging"
122
- },
123
- "$count": {
124
- "desc": "true adds metadata.count (the total matching rows) to the first page"
125
- }
126
- },
127
- "records": "PublicAssistanceGrantAwardActivities",
128
- "total": "metadata.count",
129
- "paging": {
130
- "type": "offset",
131
- "limit_param": "$top",
132
- "offset_param": "$skip",
133
- "size": 10000
134
- },
135
- "max_rows": 200000,
136
- "missing": [
137
- ""
138
- ],
139
- "flatten": true,
140
- "defaults": {
141
- "$orderby": "id"
142
- }
143
- },
144
- "pa_projects": {
145
- "path": "/v2/PublicAssistanceFundedProjectsDetails",
146
- "method": "GET",
147
- "description": "Public Assistance funded project details: project amount, federal share obligated, damage category (v2/PublicAssistanceFundedProjectsDetails).",
148
- "params": {
149
- "$filter": {
150
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
151
- },
152
- "$select": {
153
- "desc": "comma-separated fields"
154
- },
155
- "$orderby": {
156
- "desc": "e.g. declarationDate desc; set it for stable paging"
157
- },
158
- "$count": {
159
- "desc": "true adds metadata.count (the total matching rows) to the first page"
160
- }
161
- },
162
- "records": "PublicAssistanceFundedProjectsDetails",
163
- "total": "metadata.count",
164
- "paging": {
165
- "type": "offset",
166
- "limit_param": "$top",
167
- "offset_param": "$skip",
168
- "size": 10000
169
- },
170
- "max_rows": 200000,
171
- "missing": [
172
- ""
173
- ],
174
- "flatten": true
175
- },
176
- "nfip_claims": {
177
- "path": "/v3/NfipClaims",
178
- "method": "GET",
179
- "description": "NFIP flood insurance claims (redacted): date of loss, flood zone, building and contents payments (about 2.7 million rows) (v3/NfipClaims).",
180
- "params": {
181
- "$filter": {
182
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
183
- },
184
- "$select": {
185
- "desc": "comma-separated fields"
186
- },
187
- "$orderby": {
188
- "desc": "e.g. declarationDate desc; set it for stable paging"
189
- },
190
- "$count": {
191
- "desc": "true adds metadata.count (the total matching rows) to the first page"
192
- }
193
- },
194
- "records": "NfipClaims",
195
- "total": "metadata.count",
196
- "paging": {
197
- "type": "offset",
198
- "limit_param": "$top",
199
- "offset_param": "$skip",
200
- "size": 10000
201
- },
202
- "max_rows": 200000,
203
- "missing": [
204
- ""
205
- ],
206
- "flatten": true,
207
- "defaults": {
208
- "$orderby": "id"
209
- }
210
- },
211
- "nfip_policies": {
212
- "path": "/v3/NfipPolicies",
213
- "method": "GET",
214
- "description": "NFIP policy transactions (redacted): coverage, premium, flood zone (about 75 million rows; filter narrowly) (v3/NfipPolicies).",
215
- "params": {
216
- "$filter": {
217
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
218
- },
219
- "$select": {
220
- "desc": "comma-separated fields"
221
- },
222
- "$orderby": {
223
- "desc": "e.g. declarationDate desc; set it for stable paging"
224
- },
225
- "$count": {
226
- "desc": "true adds metadata.count (the total matching rows) to the first page"
227
- }
228
- },
229
- "records": "NfipPolicies",
230
- "total": "metadata.count",
231
- "paging": {
232
- "type": "offset",
233
- "limit_param": "$top",
234
- "offset_param": "$skip",
235
- "size": 10000
236
- },
237
- "max_rows": 200000,
238
- "missing": [
239
- ""
240
- ],
241
- "flatten": true,
242
- "defaults": {
243
- "$orderby": "id"
244
- }
245
- },
246
- "hmgp_summaries": {
247
- "path": "/v3/HazardMitigationGrantProgramDisasterSummaries",
248
- "method": "GET",
249
- "description": "Hazard Mitigation Grant Program disaster-level summaries: lock-in amounts, periods, status (v3/HazardMitigationGrantProgramDisasterSummaries).",
250
- "params": {
251
- "$filter": {
252
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
253
- },
254
- "$select": {
255
- "desc": "comma-separated fields"
256
- },
257
- "$orderby": {
258
- "desc": "e.g. declarationDate desc; set it for stable paging"
259
- },
260
- "$count": {
261
- "desc": "true adds metadata.count (the total matching rows) to the first page"
262
- }
263
- },
264
- "records": "HazardMitigationGrantProgramDisasterSummaries",
265
- "total": "metadata.count",
266
- "paging": {
267
- "type": "offset",
268
- "limit_param": "$top",
269
- "offset_param": "$skip",
270
- "size": 10000
271
- },
272
- "max_rows": 200000,
273
- "missing": [
274
- ""
275
- ],
276
- "flatten": true
277
- },
278
- "mission_assignments": {
279
- "path": "/v2/MissionAssignments",
280
- "method": "GET",
281
- "description": "Mission assignments: FEMA work orders to other federal agencies, obligation amounts (FY2013+) (v2/MissionAssignments).",
282
- "params": {
283
- "$filter": {
284
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
285
- },
286
- "$select": {
287
- "desc": "comma-separated fields"
288
- },
289
- "$orderby": {
290
- "desc": "e.g. declarationDate desc; set it for stable paging"
291
- },
292
- "$count": {
293
- "desc": "true adds metadata.count (the total matching rows) to the first page"
294
- }
295
- },
296
- "records": "MissionAssignments",
297
- "total": "metadata.count",
298
- "paging": {
299
- "type": "offset",
300
- "limit_param": "$top",
301
- "offset_param": "$skip",
302
- "size": 10000
303
- },
304
- "max_rows": 200000,
305
- "missing": [
306
- ""
307
- ],
308
- "flatten": true,
309
- "defaults": {
310
- "$orderby": "id"
311
- }
312
- },
313
- "ihp_registrations": {
314
- "path": "/v2/RegistrationIntakeIndividualsHouseholdPrograms",
315
- "method": "GET",
316
- "description": "IHP registration intake by disaster, county, city, ZIP: valid registrations, eligible counts and amounts (v2/RegistrationIntakeIndividualsHouseholdPrograms).",
317
- "params": {
318
- "$filter": {
319
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
320
- },
321
- "$select": {
322
- "desc": "comma-separated fields"
323
- },
324
- "$orderby": {
325
- "desc": "e.g. declarationDate desc; set it for stable paging"
326
- },
327
- "$count": {
328
- "desc": "true adds metadata.count (the total matching rows) to the first page"
329
- }
330
- },
331
- "records": "RegistrationIntakeIndividualsHouseholdPrograms",
332
- "total": "metadata.count",
333
- "paging": {
334
- "type": "offset",
335
- "limit_param": "$top",
336
- "offset_param": "$skip",
337
- "size": 10000
338
- },
339
- "max_rows": 200000,
340
- "missing": [
341
- ""
342
- ],
343
- "flatten": true,
344
- "defaults": {
345
- "$orderby": "id"
346
- }
347
- },
348
- "ihp_valid_registrations": {
349
- "path": "/v2/IndividualsAndHouseholdsProgramValidRegistrations",
350
- "method": "GET",
351
- "description": "IHP valid registrations, one row per registration (redacted; about 26 million rows; filter narrowly) (v2/IndividualsAndHouseholdsProgramValidRegistrations).",
352
- "params": {
353
- "$filter": {
354
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
355
- },
356
- "$select": {
357
- "desc": "comma-separated fields"
358
- },
359
- "$orderby": {
360
- "desc": "e.g. declarationDate desc; set it for stable paging"
361
- },
362
- "$count": {
363
- "desc": "true adds metadata.count (the total matching rows) to the first page"
364
- }
365
- },
366
- "records": "IndividualsAndHouseholdsProgramValidRegistrations",
367
- "total": "metadata.count",
368
- "paging": {
369
- "type": "offset",
370
- "limit_param": "$top",
371
- "offset_param": "$skip",
372
- "size": 10000
373
- },
374
- "max_rows": 200000,
375
- "missing": [
376
- ""
377
- ],
378
- "flatten": true,
379
- "defaults": {
380
- "$orderby": "id"
381
- }
382
- },
383
- "disaster_summaries": {
384
- "path": "/v1/FemaWebDisasterSummaries",
385
- "method": "GET",
386
- "description": "Financial totals per disaster: IHP, HA, ONA approved, PA and HMGP obligated (v1/FemaWebDisasterSummaries).",
387
- "params": {
388
- "$filter": {
389
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
390
- },
391
- "$select": {
392
- "desc": "comma-separated fields"
393
- },
394
- "$orderby": {
395
- "desc": "e.g. declarationDate desc; set it for stable paging"
396
- },
397
- "$count": {
398
- "desc": "true adds metadata.count (the total matching rows) to the first page"
399
- }
400
- },
401
- "records": "FemaWebDisasterSummaries",
402
- "total": "metadata.count",
403
- "paging": {
404
- "type": "offset",
405
- "limit_param": "$top",
406
- "offset_param": "$skip",
407
- "size": 10000
408
- },
409
- "max_rows": 200000,
410
- "missing": [
411
- ""
412
- ],
413
- "flatten": true,
414
- "defaults": {
415
- "$orderby": "id"
416
- }
417
- },
418
- "fema_regions": {
419
- "path": "/v2/FemaRegions",
420
- "method": "GET",
421
- "description": "The ten FEMA regions: offices and states (v2/FemaRegions).",
422
- "params": {
423
- "$filter": {
424
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
425
- },
426
- "$select": {
427
- "desc": "comma-separated fields"
428
- },
429
- "$orderby": {
430
- "desc": "e.g. declarationDate desc; set it for stable paging"
431
- },
432
- "$count": {
433
- "desc": "true adds metadata.count (the total matching rows) to the first page"
434
- }
435
- },
436
- "records": "FemaRegions",
437
- "total": "metadata.count",
438
- "paging": {
439
- "type": "offset",
440
- "limit_param": "$top",
441
- "offset_param": "$skip",
442
- "size": 10000
443
- },
444
- "max_rows": 200000,
445
- "missing": [
446
- ""
447
- ],
448
- "flatten": true,
449
- "defaults": {
450
- "$orderby": "id"
451
- }
452
- },
453
- "datasets": {
454
- "path": "/v1/DataSets",
455
- "method": "GET",
456
- "description": "The OpenFEMA dataset catalog: names, versions, record counts, deprecation dates (v1/DataSets).",
457
- "params": {
458
- "$filter": {
459
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
460
- },
461
- "$select": {
462
- "desc": "comma-separated fields"
463
- },
464
- "$orderby": {
465
- "desc": "e.g. declarationDate desc; set it for stable paging"
466
- },
467
- "$count": {
468
- "desc": "true adds metadata.count (the total matching rows) to the first page"
469
- }
470
- },
471
- "records": "DataSets",
472
- "total": "metadata.count",
473
- "paging": {
474
- "type": "offset",
475
- "limit_param": "$top",
476
- "offset_param": "$skip",
477
- "size": 10000
478
- },
479
- "max_rows": 200000,
480
- "missing": [
481
- ""
482
- ],
483
- "flatten": true,
484
- "defaults": {
485
- "$orderby": "id"
486
- }
487
- },
488
- "query": {
489
- "path": "/{version}/{entity}",
490
- "method": "GET",
491
- "description": "Any OpenFEMA dataset by version and entity name (CSV); see the datasets endpoint for names and versions.",
492
- "params": {
493
- "version": {
494
- "in": "path",
495
- "required": true,
496
- "desc": "dataset version: v1, v2, v3 ..."
497
- },
498
- "entity": {
499
- "in": "path",
500
- "required": true,
501
- "desc": "entity name, case-sensitive, e.g. DeclarationDenials (only entities with a csv distribution in the datasets endpoint; IpawsArchivedAlerts is JSON-only)"
502
- },
503
- "$filter": {
504
- "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
505
- },
506
- "$select": {
507
- "desc": "comma-separated fields"
508
- },
509
- "$orderby": {
510
- "desc": "e.g. declarationDate desc; set it for stable paging"
511
- },
512
- "$count": {
513
- "desc": "true adds metadata.count (the total matching rows) to the first page"
514
- }
515
- },
516
- "defaults": {
517
- "$format": "csv"
518
- },
519
- "records": "$csv",
520
- "paging": {
521
- "type": "offset",
522
- "limit_param": "$top",
523
- "offset_param": "$skip",
524
- "size": 10000
525
- },
526
- "max_rows": 200000,
527
- "missing": [
528
- ""
529
- ]
530
- }
531
- },
532
- "catalog": {
533
- "disaster_declarations": {
534
- "id": "DisasterDeclarationsSummaries",
535
- "name": "DisasterDeclarationsSummaries",
536
- "version": "v2",
537
- "description": "Disaster declarations since 1953 (DR major disaster, EM emergency, FM fire management): one row per declared county/area",
538
- "endpoint": "disaster_declarations",
539
- "page": "https://www.fema.gov/about/openfema/data-sets"
540
- },
541
- "housing_owners": {
542
- "id": "HousingAssistanceOwners",
543
- "name": "HousingAssistanceOwners",
544
- "version": "v2",
545
- "description": "Individuals and Households Program housing assistance for homeowners, by disaster, county, city and ZIP",
546
- "endpoint": "housing_owners",
547
- "page": "https://www.fema.gov/about/openfema/data-sets"
548
- },
549
- "housing_renters": {
550
- "id": "HousingAssistanceRenters",
551
- "name": "HousingAssistanceRenters",
552
- "version": "v2",
553
- "description": "IHP housing assistance for renters, by disaster, county, city and ZIP",
554
- "endpoint": "housing_renters",
555
- "page": "https://www.fema.gov/about/openfema/data-sets"
556
- },
557
- "public_assistance": {
558
- "id": "PublicAssistanceGrantAwardActivities",
559
- "name": "PublicAssistanceGrantAwardActivities",
560
- "version": "v2",
561
- "description": "Public Assistance grant award activities: applicant, county, damage category, federal share obligated",
562
- "endpoint": "public_assistance",
563
- "page": "https://www.fema.gov/about/openfema/data-sets"
564
- },
565
- "pa_projects": {
566
- "id": "PublicAssistanceFundedProjectsDetails",
567
- "name": "PublicAssistanceFundedProjectsDetails",
568
- "version": "v2",
569
- "description": "Public Assistance funded project details: project amount, federal share obligated, damage category",
570
- "endpoint": "pa_projects",
571
- "page": "https://www.fema.gov/about/openfema/data-sets"
572
- },
573
- "nfip_claims": {
574
- "id": "NfipClaims",
575
- "name": "NfipClaims",
576
- "version": "v3",
577
- "description": "NFIP flood insurance claims (redacted): date of loss, flood zone, building and contents payments (about 2.7 million rows)",
578
- "endpoint": "nfip_claims",
579
- "page": "https://www.fema.gov/about/openfema/data-sets"
580
- },
581
- "nfip_policies": {
582
- "id": "NfipPolicies",
583
- "name": "NfipPolicies",
584
- "version": "v3",
585
- "description": "NFIP policy transactions (redacted): coverage, premium, flood zone (about 75 million rows; filter narrowly)",
586
- "endpoint": "nfip_policies",
587
- "page": "https://www.fema.gov/about/openfema/data-sets"
588
- },
589
- "hmgp_summaries": {
590
- "id": "HazardMitigationGrantProgramDisasterSummaries",
591
- "name": "HazardMitigationGrantProgramDisasterSummaries",
592
- "version": "v3",
593
- "description": "Hazard Mitigation Grant Program disaster-level summaries: lock-in amounts, periods, status",
594
- "endpoint": "hmgp_summaries",
595
- "page": "https://www.fema.gov/about/openfema/data-sets"
596
- },
597
- "mission_assignments": {
598
- "id": "MissionAssignments",
599
- "name": "MissionAssignments",
600
- "version": "v2",
601
- "description": "Mission assignments: FEMA work orders to other federal agencies, obligation amounts (FY2013+)",
602
- "endpoint": "mission_assignments",
603
- "page": "https://www.fema.gov/about/openfema/data-sets"
604
- },
605
- "ihp_registrations": {
606
- "id": "RegistrationIntakeIndividualsHouseholdPrograms",
607
- "name": "RegistrationIntakeIndividualsHouseholdPrograms",
608
- "version": "v2",
609
- "description": "IHP registration intake by disaster, county, city, ZIP: valid registrations, eligible counts and amounts",
610
- "endpoint": "ihp_registrations",
611
- "page": "https://www.fema.gov/about/openfema/data-sets"
612
- },
613
- "ihp_valid_registrations": {
614
- "id": "IndividualsAndHouseholdsProgramValidRegistrations",
615
- "name": "IndividualsAndHouseholdsProgramValidRegistrations",
616
- "version": "v2",
617
- "description": "IHP valid registrations, one row per registration (redacted; about 26 million rows; filter narrowly)",
618
- "endpoint": "ihp_valid_registrations",
619
- "page": "https://www.fema.gov/about/openfema/data-sets"
620
- },
621
- "disaster_summaries": {
622
- "id": "FemaWebDisasterSummaries",
623
- "name": "FemaWebDisasterSummaries",
624
- "version": "v1",
625
- "description": "Financial totals per disaster: IHP, HA, ONA approved, PA and HMGP obligated",
626
- "endpoint": "disaster_summaries",
627
- "page": "https://www.fema.gov/about/openfema/data-sets"
628
- },
629
- "fema_regions": {
630
- "id": "FemaRegions",
631
- "name": "FemaRegions",
632
- "version": "v2",
633
- "description": "The ten FEMA regions: offices and states",
634
- "endpoint": "fema_regions",
635
- "page": "https://www.fema.gov/about/openfema/data-sets"
636
- },
637
- "datasets": {
638
- "id": "DataSets",
639
- "name": "DataSets",
640
- "version": "v1",
641
- "description": "The OpenFEMA dataset catalog: names, versions, record counts, deprecation dates",
642
- "endpoint": "datasets",
643
- "page": "https://www.fema.gov/about/openfema/data-sets"
644
- }
645
- }
1
+ {
2
+ "base_url": "https://www.fema.gov/api/open",
3
+ "endpoints": {
4
+ "disaster_declarations": {
5
+ "path": "/v2/DisasterDeclarationsSummaries",
6
+ "method": "GET",
7
+ "description": "Disaster declarations since 1953 (DR major disaster, EM emergency, FM fire management): one row per declared county/area (v2/DisasterDeclarationsSummaries).",
8
+ "params": {
9
+ "$filter": {
10
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
11
+ },
12
+ "$select": {
13
+ "desc": "comma-separated fields"
14
+ },
15
+ "$orderby": {
16
+ "desc": "e.g. declarationDate desc; set it for stable paging"
17
+ },
18
+ "$count": {
19
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
20
+ }
21
+ },
22
+ "records": "DisasterDeclarationsSummaries",
23
+ "total": "metadata.count",
24
+ "paging": {
25
+ "type": "offset",
26
+ "limit_param": "$top",
27
+ "offset_param": "$skip",
28
+ "size": 10000
29
+ },
30
+ "max_rows": 200000,
31
+ "missing": [
32
+ ""
33
+ ],
34
+ "flatten": true,
35
+ "defaults": {
36
+ "$orderby": "id"
37
+ }
38
+ },
39
+ "housing_owners": {
40
+ "path": "/v2/HousingAssistanceOwners",
41
+ "method": "GET",
42
+ "description": "Individuals and Households Program housing assistance for homeowners, by disaster, county, city and ZIP (v2/HousingAssistanceOwners).",
43
+ "params": {
44
+ "$filter": {
45
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
46
+ },
47
+ "$select": {
48
+ "desc": "comma-separated fields"
49
+ },
50
+ "$orderby": {
51
+ "desc": "e.g. declarationDate desc; set it for stable paging"
52
+ },
53
+ "$count": {
54
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
55
+ }
56
+ },
57
+ "records": "HousingAssistanceOwners",
58
+ "total": "metadata.count",
59
+ "paging": {
60
+ "type": "offset",
61
+ "limit_param": "$top",
62
+ "offset_param": "$skip",
63
+ "size": 10000
64
+ },
65
+ "max_rows": 200000,
66
+ "missing": [
67
+ ""
68
+ ],
69
+ "flatten": true,
70
+ "defaults": {
71
+ "$orderby": "id"
72
+ }
73
+ },
74
+ "housing_renters": {
75
+ "path": "/v2/HousingAssistanceRenters",
76
+ "method": "GET",
77
+ "description": "IHP housing assistance for renters, by disaster, county, city and ZIP (v2/HousingAssistanceRenters).",
78
+ "params": {
79
+ "$filter": {
80
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
81
+ },
82
+ "$select": {
83
+ "desc": "comma-separated fields"
84
+ },
85
+ "$orderby": {
86
+ "desc": "e.g. declarationDate desc; set it for stable paging"
87
+ },
88
+ "$count": {
89
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
90
+ }
91
+ },
92
+ "records": "HousingAssistanceRenters",
93
+ "total": "metadata.count",
94
+ "paging": {
95
+ "type": "offset",
96
+ "limit_param": "$top",
97
+ "offset_param": "$skip",
98
+ "size": 10000
99
+ },
100
+ "max_rows": 200000,
101
+ "missing": [
102
+ ""
103
+ ],
104
+ "flatten": true,
105
+ "defaults": {
106
+ "$orderby": "id"
107
+ }
108
+ },
109
+ "public_assistance": {
110
+ "path": "/v2/PublicAssistanceGrantAwardActivities",
111
+ "method": "GET",
112
+ "description": "Public Assistance grant award activities: applicant, county, damage category, federal share obligated (v2/PublicAssistanceGrantAwardActivities).",
113
+ "params": {
114
+ "$filter": {
115
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
116
+ },
117
+ "$select": {
118
+ "desc": "comma-separated fields"
119
+ },
120
+ "$orderby": {
121
+ "desc": "e.g. declarationDate desc; set it for stable paging"
122
+ },
123
+ "$count": {
124
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
125
+ }
126
+ },
127
+ "records": "PublicAssistanceGrantAwardActivities",
128
+ "total": "metadata.count",
129
+ "paging": {
130
+ "type": "offset",
131
+ "limit_param": "$top",
132
+ "offset_param": "$skip",
133
+ "size": 10000
134
+ },
135
+ "max_rows": 200000,
136
+ "missing": [
137
+ ""
138
+ ],
139
+ "flatten": true,
140
+ "defaults": {
141
+ "$orderby": "id"
142
+ }
143
+ },
144
+ "pa_projects": {
145
+ "path": "/v2/PublicAssistanceFundedProjectsDetails",
146
+ "method": "GET",
147
+ "description": "Public Assistance funded project details: project amount, federal share obligated, damage category (v2/PublicAssistanceFundedProjectsDetails).",
148
+ "params": {
149
+ "$filter": {
150
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
151
+ },
152
+ "$select": {
153
+ "desc": "comma-separated fields"
154
+ },
155
+ "$orderby": {
156
+ "desc": "e.g. declarationDate desc; set it for stable paging"
157
+ },
158
+ "$count": {
159
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
160
+ }
161
+ },
162
+ "records": "PublicAssistanceFundedProjectsDetails",
163
+ "total": "metadata.count",
164
+ "paging": {
165
+ "type": "offset",
166
+ "limit_param": "$top",
167
+ "offset_param": "$skip",
168
+ "size": 10000
169
+ },
170
+ "max_rows": 200000,
171
+ "missing": [
172
+ ""
173
+ ],
174
+ "flatten": true
175
+ },
176
+ "nfip_claims": {
177
+ "path": "/v3/NfipClaims",
178
+ "method": "GET",
179
+ "description": "NFIP flood insurance claims (redacted): date of loss, flood zone, building and contents payments (about 2.7 million rows) (v3/NfipClaims).",
180
+ "params": {
181
+ "$filter": {
182
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
183
+ },
184
+ "$select": {
185
+ "desc": "comma-separated fields"
186
+ },
187
+ "$orderby": {
188
+ "desc": "e.g. declarationDate desc; set it for stable paging"
189
+ },
190
+ "$count": {
191
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
192
+ }
193
+ },
194
+ "records": "NfipClaims",
195
+ "total": "metadata.count",
196
+ "paging": {
197
+ "type": "offset",
198
+ "limit_param": "$top",
199
+ "offset_param": "$skip",
200
+ "size": 10000
201
+ },
202
+ "max_rows": 200000,
203
+ "missing": [
204
+ ""
205
+ ],
206
+ "flatten": true,
207
+ "defaults": {
208
+ "$orderby": "id"
209
+ }
210
+ },
211
+ "nfip_policies": {
212
+ "path": "/v3/NfipPolicies",
213
+ "method": "GET",
214
+ "description": "NFIP policy transactions (redacted): coverage, premium, flood zone (about 75 million rows; filter narrowly) (v3/NfipPolicies).",
215
+ "params": {
216
+ "$filter": {
217
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
218
+ },
219
+ "$select": {
220
+ "desc": "comma-separated fields"
221
+ },
222
+ "$orderby": {
223
+ "desc": "e.g. declarationDate desc; set it for stable paging"
224
+ },
225
+ "$count": {
226
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
227
+ }
228
+ },
229
+ "records": "NfipPolicies",
230
+ "total": "metadata.count",
231
+ "paging": {
232
+ "type": "offset",
233
+ "limit_param": "$top",
234
+ "offset_param": "$skip",
235
+ "size": 10000
236
+ },
237
+ "max_rows": 200000,
238
+ "missing": [
239
+ ""
240
+ ],
241
+ "flatten": true,
242
+ "defaults": {
243
+ "$orderby": "id"
244
+ }
245
+ },
246
+ "hmgp_summaries": {
247
+ "path": "/v3/HazardMitigationGrantProgramDisasterSummaries",
248
+ "method": "GET",
249
+ "description": "Hazard Mitigation Grant Program disaster-level summaries: lock-in amounts, periods, status (v3/HazardMitigationGrantProgramDisasterSummaries).",
250
+ "params": {
251
+ "$filter": {
252
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
253
+ },
254
+ "$select": {
255
+ "desc": "comma-separated fields"
256
+ },
257
+ "$orderby": {
258
+ "desc": "e.g. declarationDate desc; set it for stable paging"
259
+ },
260
+ "$count": {
261
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
262
+ }
263
+ },
264
+ "records": "HazardMitigationGrantProgramDisasterSummaries",
265
+ "total": "metadata.count",
266
+ "paging": {
267
+ "type": "offset",
268
+ "limit_param": "$top",
269
+ "offset_param": "$skip",
270
+ "size": 10000
271
+ },
272
+ "max_rows": 200000,
273
+ "missing": [
274
+ ""
275
+ ],
276
+ "flatten": true
277
+ },
278
+ "mission_assignments": {
279
+ "path": "/v2/MissionAssignments",
280
+ "method": "GET",
281
+ "description": "Mission assignments: FEMA work orders to other federal agencies, obligation amounts (FY2013+) (v2/MissionAssignments).",
282
+ "params": {
283
+ "$filter": {
284
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
285
+ },
286
+ "$select": {
287
+ "desc": "comma-separated fields"
288
+ },
289
+ "$orderby": {
290
+ "desc": "e.g. declarationDate desc; set it for stable paging"
291
+ },
292
+ "$count": {
293
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
294
+ }
295
+ },
296
+ "records": "MissionAssignments",
297
+ "total": "metadata.count",
298
+ "paging": {
299
+ "type": "offset",
300
+ "limit_param": "$top",
301
+ "offset_param": "$skip",
302
+ "size": 10000
303
+ },
304
+ "max_rows": 200000,
305
+ "missing": [
306
+ ""
307
+ ],
308
+ "flatten": true,
309
+ "defaults": {
310
+ "$orderby": "id"
311
+ }
312
+ },
313
+ "ihp_registrations": {
314
+ "path": "/v2/RegistrationIntakeIndividualsHouseholdPrograms",
315
+ "method": "GET",
316
+ "description": "IHP registration intake by disaster, county, city, ZIP: valid registrations, eligible counts and amounts (v2/RegistrationIntakeIndividualsHouseholdPrograms).",
317
+ "params": {
318
+ "$filter": {
319
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
320
+ },
321
+ "$select": {
322
+ "desc": "comma-separated fields"
323
+ },
324
+ "$orderby": {
325
+ "desc": "e.g. declarationDate desc; set it for stable paging"
326
+ },
327
+ "$count": {
328
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
329
+ }
330
+ },
331
+ "records": "RegistrationIntakeIndividualsHouseholdPrograms",
332
+ "total": "metadata.count",
333
+ "paging": {
334
+ "type": "offset",
335
+ "limit_param": "$top",
336
+ "offset_param": "$skip",
337
+ "size": 10000
338
+ },
339
+ "max_rows": 200000,
340
+ "missing": [
341
+ ""
342
+ ],
343
+ "flatten": true,
344
+ "defaults": {
345
+ "$orderby": "id"
346
+ }
347
+ },
348
+ "ihp_valid_registrations": {
349
+ "path": "/v2/IndividualsAndHouseholdsProgramValidRegistrations",
350
+ "method": "GET",
351
+ "description": "IHP valid registrations, one row per registration (redacted; about 26 million rows; filter narrowly) (v2/IndividualsAndHouseholdsProgramValidRegistrations).",
352
+ "params": {
353
+ "$filter": {
354
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
355
+ },
356
+ "$select": {
357
+ "desc": "comma-separated fields"
358
+ },
359
+ "$orderby": {
360
+ "desc": "e.g. declarationDate desc; set it for stable paging"
361
+ },
362
+ "$count": {
363
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
364
+ }
365
+ },
366
+ "records": "IndividualsAndHouseholdsProgramValidRegistrations",
367
+ "total": "metadata.count",
368
+ "paging": {
369
+ "type": "offset",
370
+ "limit_param": "$top",
371
+ "offset_param": "$skip",
372
+ "size": 10000
373
+ },
374
+ "max_rows": 200000,
375
+ "missing": [
376
+ ""
377
+ ],
378
+ "flatten": true,
379
+ "defaults": {
380
+ "$orderby": "id"
381
+ }
382
+ },
383
+ "disaster_summaries": {
384
+ "path": "/v1/FemaWebDisasterSummaries",
385
+ "method": "GET",
386
+ "description": "Financial totals per disaster: IHP, HA, ONA approved, PA and HMGP obligated (v1/FemaWebDisasterSummaries).",
387
+ "params": {
388
+ "$filter": {
389
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
390
+ },
391
+ "$select": {
392
+ "desc": "comma-separated fields"
393
+ },
394
+ "$orderby": {
395
+ "desc": "e.g. declarationDate desc; set it for stable paging"
396
+ },
397
+ "$count": {
398
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
399
+ }
400
+ },
401
+ "records": "FemaWebDisasterSummaries",
402
+ "total": "metadata.count",
403
+ "paging": {
404
+ "type": "offset",
405
+ "limit_param": "$top",
406
+ "offset_param": "$skip",
407
+ "size": 10000
408
+ },
409
+ "max_rows": 200000,
410
+ "missing": [
411
+ ""
412
+ ],
413
+ "flatten": true,
414
+ "defaults": {
415
+ "$orderby": "id"
416
+ }
417
+ },
418
+ "fema_regions": {
419
+ "path": "/v2/FemaRegions",
420
+ "method": "GET",
421
+ "description": "The ten FEMA regions: offices and states (v2/FemaRegions).",
422
+ "params": {
423
+ "$filter": {
424
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
425
+ },
426
+ "$select": {
427
+ "desc": "comma-separated fields"
428
+ },
429
+ "$orderby": {
430
+ "desc": "e.g. declarationDate desc; set it for stable paging"
431
+ },
432
+ "$count": {
433
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
434
+ }
435
+ },
436
+ "records": "FemaRegions",
437
+ "total": "metadata.count",
438
+ "paging": {
439
+ "type": "offset",
440
+ "limit_param": "$top",
441
+ "offset_param": "$skip",
442
+ "size": 10000
443
+ },
444
+ "max_rows": 200000,
445
+ "missing": [
446
+ ""
447
+ ],
448
+ "flatten": true,
449
+ "defaults": {
450
+ "$orderby": "id"
451
+ }
452
+ },
453
+ "datasets": {
454
+ "path": "/v1/DataSets",
455
+ "method": "GET",
456
+ "description": "The OpenFEMA dataset catalog: names, versions, record counts, deprecation dates (v1/DataSets).",
457
+ "params": {
458
+ "$filter": {
459
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
460
+ },
461
+ "$select": {
462
+ "desc": "comma-separated fields"
463
+ },
464
+ "$orderby": {
465
+ "desc": "e.g. declarationDate desc; set it for stable paging"
466
+ },
467
+ "$count": {
468
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
469
+ }
470
+ },
471
+ "records": "DataSets",
472
+ "total": "metadata.count",
473
+ "paging": {
474
+ "type": "offset",
475
+ "limit_param": "$top",
476
+ "offset_param": "$skip",
477
+ "size": 10000
478
+ },
479
+ "max_rows": 200000,
480
+ "missing": [
481
+ ""
482
+ ],
483
+ "flatten": true,
484
+ "defaults": {
485
+ "$orderby": "id"
486
+ }
487
+ },
488
+ "query": {
489
+ "path": "/{version}/{entity}",
490
+ "method": "GET",
491
+ "description": "Any OpenFEMA dataset by version and entity name (CSV); see the datasets endpoint for names and versions.",
492
+ "params": {
493
+ "version": {
494
+ "in": "path",
495
+ "required": true,
496
+ "desc": "dataset version: v1, v2, v3 ..."
497
+ },
498
+ "entity": {
499
+ "in": "path",
500
+ "required": true,
501
+ "desc": "entity name, case-sensitive, e.g. DeclarationDenials (only entities with a csv distribution in the datasets endpoint; IpawsArchivedAlerts is JSON-only)"
502
+ },
503
+ "$filter": {
504
+ "desc": "OData filter: state eq 'TX' and fyDeclared ge 2020 (text in single quotes; field names are case-sensitive)"
505
+ },
506
+ "$select": {
507
+ "desc": "comma-separated fields"
508
+ },
509
+ "$orderby": {
510
+ "desc": "e.g. declarationDate desc; set it for stable paging"
511
+ },
512
+ "$count": {
513
+ "desc": "true adds metadata.count (the total matching rows) to the first page"
514
+ }
515
+ },
516
+ "defaults": {
517
+ "$format": "csv"
518
+ },
519
+ "records": "$csv",
520
+ "paging": {
521
+ "type": "offset",
522
+ "limit_param": "$top",
523
+ "offset_param": "$skip",
524
+ "size": 10000
525
+ },
526
+ "max_rows": 200000,
527
+ "missing": [
528
+ ""
529
+ ]
530
+ }
531
+ },
532
+ "catalog": {
533
+ "disaster_declarations": {
534
+ "id": "DisasterDeclarationsSummaries",
535
+ "name": "DisasterDeclarationsSummaries",
536
+ "version": "v2",
537
+ "description": "Disaster declarations since 1953 (DR major disaster, EM emergency, FM fire management): one row per declared county/area",
538
+ "endpoint": "disaster_declarations",
539
+ "page": "https://www.fema.gov/about/openfema/data-sets"
540
+ },
541
+ "housing_owners": {
542
+ "id": "HousingAssistanceOwners",
543
+ "name": "HousingAssistanceOwners",
544
+ "version": "v2",
545
+ "description": "Individuals and Households Program housing assistance for homeowners, by disaster, county, city and ZIP",
546
+ "endpoint": "housing_owners",
547
+ "page": "https://www.fema.gov/about/openfema/data-sets"
548
+ },
549
+ "housing_renters": {
550
+ "id": "HousingAssistanceRenters",
551
+ "name": "HousingAssistanceRenters",
552
+ "version": "v2",
553
+ "description": "IHP housing assistance for renters, by disaster, county, city and ZIP",
554
+ "endpoint": "housing_renters",
555
+ "page": "https://www.fema.gov/about/openfema/data-sets"
556
+ },
557
+ "public_assistance": {
558
+ "id": "PublicAssistanceGrantAwardActivities",
559
+ "name": "PublicAssistanceGrantAwardActivities",
560
+ "version": "v2",
561
+ "description": "Public Assistance grant award activities: applicant, county, damage category, federal share obligated",
562
+ "endpoint": "public_assistance",
563
+ "page": "https://www.fema.gov/about/openfema/data-sets"
564
+ },
565
+ "pa_projects": {
566
+ "id": "PublicAssistanceFundedProjectsDetails",
567
+ "name": "PublicAssistanceFundedProjectsDetails",
568
+ "version": "v2",
569
+ "description": "Public Assistance funded project details: project amount, federal share obligated, damage category",
570
+ "endpoint": "pa_projects",
571
+ "page": "https://www.fema.gov/about/openfema/data-sets"
572
+ },
573
+ "nfip_claims": {
574
+ "id": "NfipClaims",
575
+ "name": "NfipClaims",
576
+ "version": "v3",
577
+ "description": "NFIP flood insurance claims (redacted): date of loss, flood zone, building and contents payments (about 2.7 million rows)",
578
+ "endpoint": "nfip_claims",
579
+ "page": "https://www.fema.gov/about/openfema/data-sets"
580
+ },
581
+ "nfip_policies": {
582
+ "id": "NfipPolicies",
583
+ "name": "NfipPolicies",
584
+ "version": "v3",
585
+ "description": "NFIP policy transactions (redacted): coverage, premium, flood zone (about 75 million rows; filter narrowly)",
586
+ "endpoint": "nfip_policies",
587
+ "page": "https://www.fema.gov/about/openfema/data-sets"
588
+ },
589
+ "hmgp_summaries": {
590
+ "id": "HazardMitigationGrantProgramDisasterSummaries",
591
+ "name": "HazardMitigationGrantProgramDisasterSummaries",
592
+ "version": "v3",
593
+ "description": "Hazard Mitigation Grant Program disaster-level summaries: lock-in amounts, periods, status",
594
+ "endpoint": "hmgp_summaries",
595
+ "page": "https://www.fema.gov/about/openfema/data-sets"
596
+ },
597
+ "mission_assignments": {
598
+ "id": "MissionAssignments",
599
+ "name": "MissionAssignments",
600
+ "version": "v2",
601
+ "description": "Mission assignments: FEMA work orders to other federal agencies, obligation amounts (FY2013+)",
602
+ "endpoint": "mission_assignments",
603
+ "page": "https://www.fema.gov/about/openfema/data-sets"
604
+ },
605
+ "ihp_registrations": {
606
+ "id": "RegistrationIntakeIndividualsHouseholdPrograms",
607
+ "name": "RegistrationIntakeIndividualsHouseholdPrograms",
608
+ "version": "v2",
609
+ "description": "IHP registration intake by disaster, county, city, ZIP: valid registrations, eligible counts and amounts",
610
+ "endpoint": "ihp_registrations",
611
+ "page": "https://www.fema.gov/about/openfema/data-sets"
612
+ },
613
+ "ihp_valid_registrations": {
614
+ "id": "IndividualsAndHouseholdsProgramValidRegistrations",
615
+ "name": "IndividualsAndHouseholdsProgramValidRegistrations",
616
+ "version": "v2",
617
+ "description": "IHP valid registrations, one row per registration (redacted; about 26 million rows; filter narrowly)",
618
+ "endpoint": "ihp_valid_registrations",
619
+ "page": "https://www.fema.gov/about/openfema/data-sets"
620
+ },
621
+ "disaster_summaries": {
622
+ "id": "FemaWebDisasterSummaries",
623
+ "name": "FemaWebDisasterSummaries",
624
+ "version": "v1",
625
+ "description": "Financial totals per disaster: IHP, HA, ONA approved, PA and HMGP obligated",
626
+ "endpoint": "disaster_summaries",
627
+ "page": "https://www.fema.gov/about/openfema/data-sets"
628
+ },
629
+ "fema_regions": {
630
+ "id": "FemaRegions",
631
+ "name": "FemaRegions",
632
+ "version": "v2",
633
+ "description": "The ten FEMA regions: offices and states",
634
+ "endpoint": "fema_regions",
635
+ "page": "https://www.fema.gov/about/openfema/data-sets"
636
+ },
637
+ "datasets": {
638
+ "id": "DataSets",
639
+ "name": "DataSets",
640
+ "version": "v1",
641
+ "description": "The OpenFEMA dataset catalog: names, versions, record counts, deprecation dates",
642
+ "endpoint": "datasets",
643
+ "page": "https://www.fema.gov/about/openfema/data-sets"
644
+ }
645
+ }
646
646
  }