data-analyst-mcp 0.3.0 → 0.3.1

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 (153) hide show
  1. package/README.md +262 -262
  2. package/dist/report/method_audit.js +7 -1
  3. package/dist/report/method_audit.js.map +1 -1
  4. package/dist/report/scan_secrets.d.ts +4 -1
  5. package/dist/report/scan_secrets.js +36 -5
  6. package/dist/report/scan_secrets.js.map +1 -1
  7. package/dist/server.d.ts +1 -1
  8. package/dist/server.js +3 -2
  9. package/dist/server.js.map +1 -1
  10. package/guide/WORKFLOW.md +134 -134
  11. package/guide/assets/disclaimer.txt +1 -1
  12. package/guide/assets/download_data.ps1 +162 -162
  13. package/guide/assets/report_template.html +597 -597
  14. package/guide/references/routing.md +171 -171
  15. package/guide/references/style_guide.md +398 -398
  16. package/package.json +56 -56
  17. package/packs/acf/endpoints.json +114 -114
  18. package/packs/acf/policy.json +104 -104
  19. package/packs/actuaries/endpoints.json +82 -82
  20. package/packs/actuaries/policy.json +109 -109
  21. package/packs/bea/assets/download_bea.ps1 +182 -182
  22. package/packs/bea/docs/bea_api.md +461 -461
  23. package/packs/bea/docs/datasets.md +157 -157
  24. package/packs/bea/docs/report_patterns.md +112 -112
  25. package/packs/bea/policy.json +170 -170
  26. package/packs/bea/source.md +152 -152
  27. package/packs/bls/assets/download_bls.ps1 +152 -152
  28. package/packs/bls/docs/analysis_patterns.md +108 -108
  29. package/packs/bls/docs/bls_api.md +73 -73
  30. package/packs/bls/docs/series_ids.md +149 -149
  31. package/packs/bls/policy.json +238 -238
  32. package/packs/bts/endpoints.json +346 -346
  33. package/packs/bts/policy.json +94 -94
  34. package/packs/cdc/endpoints.json +197 -197
  35. package/packs/cdc/policy.json +83 -83
  36. package/packs/census/endpoints.json +99 -99
  37. package/packs/cfpb/endpoints.json +326 -326
  38. package/packs/cfpb/policy.json +119 -119
  39. package/packs/clinical-trials/endpoints.json +166 -166
  40. package/packs/clinical-trials/policy.json +84 -84
  41. package/packs/cms/endpoints.json +69 -69
  42. package/packs/cms/policy.json +96 -96
  43. package/packs/college-scorecard/endpoints.json +252 -252
  44. package/packs/college-scorecard/policy.json +106 -106
  45. package/packs/congress/endpoints.json +1701 -1701
  46. package/packs/congress/policy.json +117 -117
  47. package/packs/dhs-ohss/endpoints.json +66 -66
  48. package/packs/dhs-ohss/policy.json +107 -107
  49. package/packs/doj-news/endpoints.json +59 -59
  50. package/packs/doj-news/policy.json +96 -96
  51. package/packs/dol/endpoints.json +817 -817
  52. package/packs/dol/policy.json +135 -135
  53. package/packs/eia/endpoints.json +717 -717
  54. package/packs/eia/policy.json +112 -112
  55. package/packs/epa/endpoints.json +291 -291
  56. package/packs/epa/policy.json +99 -99
  57. package/packs/epa-aqs/endpoints.json +173 -173
  58. package/packs/epa-aqs/policy.json +96 -96
  59. package/packs/fbi/endpoints.json +1841 -1841
  60. package/packs/fbi/policy.json +118 -118
  61. package/packs/fda/endpoints.json +237 -237
  62. package/packs/fda/policy.json +121 -121
  63. package/packs/fdic/endpoints.json +416 -416
  64. package/packs/fdic/policy.json +83 -83
  65. package/packs/fec/endpoints.json +707 -707
  66. package/packs/fec/policy.json +93 -93
  67. package/packs/fed-board/endpoints.json +89 -89
  68. package/packs/fed-board/policy.json +136 -136
  69. package/packs/federal-register/endpoints.json +143 -143
  70. package/packs/federal-register/policy.json +86 -86
  71. package/packs/fema/endpoints.json +645 -645
  72. package/packs/fema/policy.json +103 -103
  73. package/packs/fhfa/endpoints.json +105 -105
  74. package/packs/fhfa/policy.json +109 -109
  75. package/packs/fred/assets/download_fred.ps1 +122 -122
  76. package/packs/fred/docs/analysis_patterns.md +124 -124
  77. package/packs/fred/docs/fred_api.md +94 -94
  78. package/packs/fred/docs/series.md +188 -188
  79. package/packs/fred/policy.json +253 -253
  80. package/packs/fsa/endpoints.json +150 -150
  81. package/packs/fsa/policy.json +99 -99
  82. package/packs/govinfo/endpoints.json +519 -519
  83. package/packs/gsa-calc/endpoints.json +93 -93
  84. package/packs/gsa-calc/policy.json +97 -97
  85. package/packs/hud/endpoints.json +146 -146
  86. package/packs/hud/policy.json +84 -84
  87. package/packs/ipums/docs/report_patterns.md +117 -117
  88. package/packs/irs-soi/endpoints.json +114 -114
  89. package/packs/irs-soi/policy.json +107 -107
  90. package/packs/medicaid/endpoints.json +412 -412
  91. package/packs/medicaid/policy.json +108 -108
  92. package/packs/naep/endpoints.json +217 -217
  93. package/packs/naep/policy.json +100 -100
  94. package/packs/nhtsa/endpoints.json +132 -132
  95. package/packs/nhtsa/policy.json +93 -93
  96. package/packs/nih/endpoints.json +452 -452
  97. package/packs/nih/policy.json +86 -86
  98. package/packs/noaa/endpoints.json +431 -431
  99. package/packs/noaa/policy.json +95 -95
  100. package/packs/nrel/endpoints.json +327 -327
  101. package/packs/nrel/policy.json +96 -96
  102. package/packs/nws/endpoints.json +271 -271
  103. package/packs/nws/policy.json +82 -82
  104. package/packs/nyfed/endpoints.json +80 -80
  105. package/packs/nyfed/policy.json +92 -92
  106. package/packs/omb/endpoints.json +460 -460
  107. package/packs/omb/policy.json +106 -106
  108. package/packs/open-payments/endpoints.json +297 -297
  109. package/packs/open-payments/policy.json +101 -101
  110. package/packs/opm/assets/download_opm.ps1 +125 -125
  111. package/packs/opm/docs/fields.md +184 -184
  112. package/packs/opm/docs/opm_api.md +71 -71
  113. package/packs/opm/docs/report_patterns.md +83 -83
  114. package/packs/opm/lib/data_dictionary.csv +73 -73
  115. package/packs/pbgc/endpoints.json +483 -483
  116. package/packs/pbgc/policy.json +94 -94
  117. package/packs/philfed/endpoints.json +85 -85
  118. package/packs/philfed/policy.json +94 -94
  119. package/packs/regulations/endpoints.json +287 -287
  120. package/packs/regulations/policy.json +86 -86
  121. package/packs/sec/endpoints.json +236 -236
  122. package/packs/sec/policy.json +86 -86
  123. package/packs/senate-lobbying/endpoints.json +553 -553
  124. package/packs/senate-lobbying/policy.json +99 -99
  125. package/packs/snapqc/endpoints.json +1426 -1426
  126. package/packs/snapqc/policy.json +92 -92
  127. package/packs/treasury/catalog.json +2267 -2267
  128. package/packs/treasury/docs/api_guide.md +245 -245
  129. package/packs/treasury/docs/datasets.md +56 -56
  130. package/packs/treasury/docs/report_patterns.md +126 -126
  131. package/packs/treasury/policy.json +159 -159
  132. package/packs/treasury/source.md +170 -165
  133. package/packs/treasury-yields/endpoints.json +226 -226
  134. package/packs/treasury-yields/policy.json +86 -86
  135. package/packs/usaspending/endpoints.json +1315 -1315
  136. package/packs/usaspending/policy.json +109 -109
  137. package/packs/usda-fna/policy.json +133 -133
  138. package/packs/usda-fooddata/endpoints.json +180 -180
  139. package/packs/usda-fooddata/policy.json +94 -94
  140. package/packs/usda-nass/endpoints.json +323 -323
  141. package/packs/usda-nass/policy.json +95 -95
  142. package/packs/usda-outlook/endpoints.json +86 -86
  143. package/packs/usda-outlook/policy.json +109 -109
  144. package/packs/usgs/endpoints.json +313 -313
  145. package/packs/usgs/policy.json +95 -95
  146. package/packs/usitc/endpoints.json +74 -74
  147. package/packs/usitc/policy.json +111 -111
  148. package/packs/uspto/endpoints.json +141 -141
  149. package/packs/uspto/policy.json +95 -95
  150. package/packs/va/endpoints.json +414 -414
  151. package/packs/va/policy.json +101 -101
  152. package/packs/world-bank/endpoints.json +122 -122
  153. 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
  }