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,181 +1,181 @@
1
- {
2
- "base_url": "https://api.nal.usda.gov/fdc/v1",
3
- "retry_html_400": 3,
4
- "endpoints": {
5
- "search": {
6
- "path": "/foods/search",
7
- "method": "GET",
8
- "description": "Foods matching a query (200 a page), with their nutrients.",
9
- "params": {
10
- "query": {
11
- "required": true,
12
- "desc": "search words, e.g. cheddar cheese; supports +word, -word, \"phrases\" and field queries such as foodCategory:\"Cheese\" or +foodCategory:\"Cheese\" +ingredients:\"annatto\" (quote a value of several words; spell category names exactly as FDC does)"
13
- },
14
- "dataType": {
15
- "desc": "Foundation, SR Legacy, Survey (FNDDS), Branded, Experimental (list or comma text)"
16
- },
17
- "brandOwner": {
18
- "desc": "Branded foods only: brand owner name"
19
- },
20
- "sortBy": {
21
- "desc": "dataType.keyword, lowercaseDescription.keyword, fdcId, publishedDate"
22
- },
23
- "sortOrder": {
24
- "desc": "asc or desc"
25
- }
26
- },
27
- "records": "foods",
28
- "total": "totalHits",
29
- "paging": {
30
- "type": "page",
31
- "page_param": "pageNumber",
32
- "size_param": "pageSize",
33
- "size": 200,
34
- "start": 1
35
- },
36
- "max_rows": 10000,
37
- "missing": [
38
- ""
39
- ],
40
- "flatten": true
41
- },
42
- "food": {
43
- "path": "/food/{fdcId}",
44
- "method": "GET",
45
- "description": "One food by FDC id, with every nutrient (format full) or the main ones (abridged).",
46
- "params": {
47
- "fdcId": {
48
- "in": "path",
49
- "required": true,
50
- "desc": "FoodData Central id, e.g. 328637"
51
- },
52
- "format": {
53
- "desc": "full (default) or abridged",
54
- "enum": [
55
- "full",
56
- "abridged"
57
- ]
58
- },
59
- "nutrients": {
60
- "desc": "nutrient NUMBERS to keep, e.g. 203,204,208 (protein, fat, energy)"
61
- }
62
- },
63
- "records": "",
64
- "paging": {
65
- "type": "none"
66
- },
67
- "max_rows": 1,
68
- "missing": [
69
- ""
70
- ],
71
- "flatten": true
72
- },
73
- "foods": {
74
- "path": "/foods",
75
- "method": "GET",
76
- "description": "Up to 20 foods by FDC id in one call (the documented maximum; the API silently drops ids past 50).",
77
- "params": {
78
- "fdcIds": {
79
- "required": true,
80
- "desc": "comma-separated FDC ids, or a list; the pack refuses more than 20 (the API silently drops extra ids)"
81
- },
82
- "format": {
83
- "desc": "abridged (default here) or full",
84
- "enum": [
85
- "full",
86
- "abridged"
87
- ]
88
- },
89
- "nutrients": {
90
- "desc": "nutrient numbers to keep, e.g. 203,204,208"
91
- }
92
- },
93
- "defaults": {
94
- "format": "abridged"
95
- },
96
- "records": "",
97
- "paging": {
98
- "type": "none"
99
- },
100
- "max_rows": 20,
101
- "missing": [
102
- ""
103
- ],
104
- "flatten": true
105
- },
106
- "list": {
107
- "path": "/foods/list",
108
- "method": "GET",
109
- "description": "Every food of a data type, paged (abridged nutrients).",
110
- "params": {
111
- "dataType": {
112
- "desc": "Foundation, SR Legacy, Survey (FNDDS), Branded"
113
- },
114
- "sortBy": {
115
- "desc": "dataType.keyword, lowercaseDescription.keyword, fdcId, publishedDate"
116
- },
117
- "sortOrder": {
118
- "desc": "asc or desc"
119
- }
120
- },
121
- "records": "",
122
- "paging": {
123
- "type": "page",
124
- "page_param": "pageNumber",
125
- "size_param": "pageSize",
126
- "size": 200,
127
- "start": 1
128
- },
129
- "max_rows": 20000,
130
- "missing": [
131
- ""
132
- ],
133
- "flatten": true
134
- }
135
- },
136
- "catalog": {
137
- "foundation": {
138
- "id": "Foundation",
139
- "name": "Foundation Foods",
140
- "description": "Minimally processed foods with analytical nutrient values and metadata (dataType Foundation)",
141
- "endpoint": "search"
142
- },
143
- "sr_legacy": {
144
- "id": "SR Legacy",
145
- "name": "SR Legacy",
146
- "description": "USDA National Nutrient Database for Standard Reference, final 2018 release (dataType SR Legacy)",
147
- "endpoint": "search"
148
- },
149
- "survey_fndds": {
150
- "id": "Survey (FNDDS)",
151
- "name": "Food and Nutrient Database for Dietary Studies",
152
- "description": "Foods as eaten in What We Eat in America / NHANES (dataType Survey (FNDDS))",
153
- "endpoint": "search"
154
- },
155
- "branded": {
156
- "id": "Branded",
157
- "name": "Global Branded Food Products Database",
158
- "description": "Label data for branded products from manufacturers (dataType Branded; the largest set)",
159
- "endpoint": "search"
160
- }
161
- },
162
- "nutrient_numbers": {
163
- "208": "Energy (kcal)",
164
- "203": "Protein (g)",
165
- "204": "Total lipid (fat) (g)",
166
- "205": "Carbohydrate, by difference (g)",
167
- "269": "Total sugars (g)",
168
- "291": "Fiber, total dietary (g)",
169
- "307": "Sodium, Na (mg)",
170
- "301": "Calcium, Ca (mg)",
171
- "303": "Iron, Fe (mg)",
172
- "306": "Potassium, K (mg)",
173
- "601": "Cholesterol (mg)",
174
- "606": "Fatty acids, total saturated (g)",
175
- "605": "Fatty acids, total trans (g)",
176
- "401": "Vitamin C (mg)",
177
- "320": "Vitamin A, RAE (ug)",
178
- "328": "Vitamin D (D2 + D3) (ug)",
179
- "255": "Water (g)"
180
- }
1
+ {
2
+ "base_url": "https://api.nal.usda.gov/fdc/v1",
3
+ "retry_html_400": 3,
4
+ "endpoints": {
5
+ "search": {
6
+ "path": "/foods/search",
7
+ "method": "GET",
8
+ "description": "Foods matching a query (200 a page), with their nutrients.",
9
+ "params": {
10
+ "query": {
11
+ "required": true,
12
+ "desc": "search words, e.g. cheddar cheese; supports +word, -word, \"phrases\" and field queries such as foodCategory:\"Cheese\" or +foodCategory:\"Cheese\" +ingredients:\"annatto\" (quote a value of several words; spell category names exactly as FDC does)"
13
+ },
14
+ "dataType": {
15
+ "desc": "Foundation, SR Legacy, Survey (FNDDS), Branded, Experimental (list or comma text)"
16
+ },
17
+ "brandOwner": {
18
+ "desc": "Branded foods only: brand owner name"
19
+ },
20
+ "sortBy": {
21
+ "desc": "dataType.keyword, lowercaseDescription.keyword, fdcId, publishedDate"
22
+ },
23
+ "sortOrder": {
24
+ "desc": "asc or desc"
25
+ }
26
+ },
27
+ "records": "foods",
28
+ "total": "totalHits",
29
+ "paging": {
30
+ "type": "page",
31
+ "page_param": "pageNumber",
32
+ "size_param": "pageSize",
33
+ "size": 200,
34
+ "start": 1
35
+ },
36
+ "max_rows": 10000,
37
+ "missing": [
38
+ ""
39
+ ],
40
+ "flatten": true
41
+ },
42
+ "food": {
43
+ "path": "/food/{fdcId}",
44
+ "method": "GET",
45
+ "description": "One food by FDC id, with every nutrient (format full) or the main ones (abridged).",
46
+ "params": {
47
+ "fdcId": {
48
+ "in": "path",
49
+ "required": true,
50
+ "desc": "FoodData Central id, e.g. 328637"
51
+ },
52
+ "format": {
53
+ "desc": "full (default) or abridged",
54
+ "enum": [
55
+ "full",
56
+ "abridged"
57
+ ]
58
+ },
59
+ "nutrients": {
60
+ "desc": "nutrient NUMBERS to keep, e.g. 203,204,208 (protein, fat, energy)"
61
+ }
62
+ },
63
+ "records": "",
64
+ "paging": {
65
+ "type": "none"
66
+ },
67
+ "max_rows": 1,
68
+ "missing": [
69
+ ""
70
+ ],
71
+ "flatten": true
72
+ },
73
+ "foods": {
74
+ "path": "/foods",
75
+ "method": "GET",
76
+ "description": "Up to 20 foods by FDC id in one call (the documented maximum; the API silently drops ids past 50).",
77
+ "params": {
78
+ "fdcIds": {
79
+ "required": true,
80
+ "desc": "comma-separated FDC ids, or a list; the pack refuses more than 20 (the API silently drops extra ids)"
81
+ },
82
+ "format": {
83
+ "desc": "abridged (default here) or full",
84
+ "enum": [
85
+ "full",
86
+ "abridged"
87
+ ]
88
+ },
89
+ "nutrients": {
90
+ "desc": "nutrient numbers to keep, e.g. 203,204,208"
91
+ }
92
+ },
93
+ "defaults": {
94
+ "format": "abridged"
95
+ },
96
+ "records": "",
97
+ "paging": {
98
+ "type": "none"
99
+ },
100
+ "max_rows": 20,
101
+ "missing": [
102
+ ""
103
+ ],
104
+ "flatten": true
105
+ },
106
+ "list": {
107
+ "path": "/foods/list",
108
+ "method": "GET",
109
+ "description": "Every food of a data type, paged (abridged nutrients).",
110
+ "params": {
111
+ "dataType": {
112
+ "desc": "Foundation, SR Legacy, Survey (FNDDS), Branded"
113
+ },
114
+ "sortBy": {
115
+ "desc": "dataType.keyword, lowercaseDescription.keyword, fdcId, publishedDate"
116
+ },
117
+ "sortOrder": {
118
+ "desc": "asc or desc"
119
+ }
120
+ },
121
+ "records": "",
122
+ "paging": {
123
+ "type": "page",
124
+ "page_param": "pageNumber",
125
+ "size_param": "pageSize",
126
+ "size": 200,
127
+ "start": 1
128
+ },
129
+ "max_rows": 20000,
130
+ "missing": [
131
+ ""
132
+ ],
133
+ "flatten": true
134
+ }
135
+ },
136
+ "catalog": {
137
+ "foundation": {
138
+ "id": "Foundation",
139
+ "name": "Foundation Foods",
140
+ "description": "Minimally processed foods with analytical nutrient values and metadata (dataType Foundation)",
141
+ "endpoint": "search"
142
+ },
143
+ "sr_legacy": {
144
+ "id": "SR Legacy",
145
+ "name": "SR Legacy",
146
+ "description": "USDA National Nutrient Database for Standard Reference, final 2018 release (dataType SR Legacy)",
147
+ "endpoint": "search"
148
+ },
149
+ "survey_fndds": {
150
+ "id": "Survey (FNDDS)",
151
+ "name": "Food and Nutrient Database for Dietary Studies",
152
+ "description": "Foods as eaten in What We Eat in America / NHANES (dataType Survey (FNDDS))",
153
+ "endpoint": "search"
154
+ },
155
+ "branded": {
156
+ "id": "Branded",
157
+ "name": "Global Branded Food Products Database",
158
+ "description": "Label data for branded products from manufacturers (dataType Branded; the largest set)",
159
+ "endpoint": "search"
160
+ }
161
+ },
162
+ "nutrient_numbers": {
163
+ "208": "Energy (kcal)",
164
+ "203": "Protein (g)",
165
+ "204": "Total lipid (fat) (g)",
166
+ "205": "Carbohydrate, by difference (g)",
167
+ "269": "Total sugars (g)",
168
+ "291": "Fiber, total dietary (g)",
169
+ "307": "Sodium, Na (mg)",
170
+ "301": "Calcium, Ca (mg)",
171
+ "303": "Iron, Fe (mg)",
172
+ "306": "Potassium, K (mg)",
173
+ "601": "Cholesterol (mg)",
174
+ "606": "Fatty acids, total saturated (g)",
175
+ "605": "Fatty acids, total trans (g)",
176
+ "401": "Vitamin C (mg)",
177
+ "320": "Vitamin A, RAE (ug)",
178
+ "328": "Vitamin D (D2 + D3) (ug)",
179
+ "255": "Water (g)"
180
+ }
181
181
  }
@@ -1,94 +1,94 @@
1
- {
2
- "id": "usda-fooddata",
3
- "title": "USDA FoodData Central",
4
- "agency": "U.S. Department of Agriculture, Agricultural Research Service",
5
- "depth": "standard",
6
- "domains": [
7
- "nutrition",
8
- "food",
9
- "health",
10
- "agriculture"
11
- ],
12
- "keywords": [
13
- "nutrition",
14
- "nutrient",
15
- "nutrients",
16
- "calories",
17
- "protein",
18
- "fat",
19
- "sugar",
20
- "sodium",
21
- "fiber",
22
- "vitamin",
23
- "mineral",
24
- "food composition",
25
- "fooddata central",
26
- "fdc",
27
- "branded food",
28
- "sr legacy",
29
- "fndds",
30
- "foundation foods",
31
- "ingredients",
32
- "serving size"
33
- ],
34
- "questions": [
35
- "calories and protein in a food",
36
- "sodium content of branded products",
37
- "compare nutrients of several foods",
38
- "vitamin content per 100 grams",
39
- "nutrients of foods as eaten in NHANES (FNDDS)"
40
- ],
41
- "homepage": "https://fdc.nal.usda.gov/",
42
- "terms_url": "https://fdc.nal.usda.gov/api-guide",
43
- "auth": {
44
- "env": "DATA_GOV_API_KEY",
45
- "required": "optional",
46
- "placement": "query",
47
- "param": "api_key",
48
- "home": "data-gov",
49
- "signup_url": "https://fdc.nal.usda.gov/api-key-signup",
50
- "echoes_key": false,
51
- "key_only": [
52
- "more than a few requests an hour (DEMO_KEY limits; a free key allows 1,000 an hour)"
53
- ],
54
- "demo_key": "DEMO_KEY"
55
- },
56
- "limits": {
57
- "rps": 2,
58
- "burst": 4,
59
- "max_rows": 200000
60
- },
61
- "routes": {
62
- "api": {
63
- "base": "https://api.nal.usda.gov/fdc/v1",
64
- "probe": "https://api.nal.usda.gov/fdc/v1/foods/search?query=apple&pageSize=1",
65
- "hosts": [
66
- "api.nal.usda.gov"
67
- ]
68
- },
69
- "manual": {
70
- "how": "Open the links in INSTRUCTIONS.md (they carry DEMO_KEY, which works in a browser for a few requests; replace it with your own api.data.gov key if refused), save each under the shown name and upload. For whole data types download CSV or JSON from https://fdc.nal.usda.gov/download-datasets, or search https://fdc.nal.usda.gov/food-search and download a food's data."
71
- }
72
- },
73
- "cache": {
74
- "mode": "run_only",
75
- "ttl_hours": null,
76
- "why": "Requests are small; FDC publishes new releases of each data type periodically (publishedDate per food). data/ is reused within a run."
77
- },
78
- "redistribution": {
79
- "mode": "allowed",
80
- "why": "FoodData Central data are in the public domain under CC0 1.0 (https://fdc.nal.usda.gov/api-guide, Licensing); USDA asks that FoodData Central be listed as the source."
81
- },
82
- "notices": [],
83
- "retention": null,
84
- "citation": "U.S. Department of Agriculture, Agricultural Research Service. FoodData Central: {dataset}. fdc.nal.usda.gov, retrieved {retrieved_long}.",
85
- "audit_hooks": [],
86
- "clarify": [
87
- "Which data type: Foundation (generic foods, analytical values), SR Legacy (generic foods, final 2018 release), Survey (FNDDS, foods as eaten), or Branded (label values of specific products)?",
88
- "Per 100 g (how FDC reports nutrients) or per serving? Per-serving values need the food's serving size or portion weight."
89
- ],
90
- "formats": [
91
- "json",
92
- "csv"
93
- ]
94
- }
1
+ {
2
+ "id": "usda-fooddata",
3
+ "title": "USDA FoodData Central",
4
+ "agency": "U.S. Department of Agriculture, Agricultural Research Service",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "nutrition",
8
+ "food",
9
+ "health",
10
+ "agriculture"
11
+ ],
12
+ "keywords": [
13
+ "nutrition",
14
+ "nutrient",
15
+ "nutrients",
16
+ "calories",
17
+ "protein",
18
+ "fat",
19
+ "sugar",
20
+ "sodium",
21
+ "fiber",
22
+ "vitamin",
23
+ "mineral",
24
+ "food composition",
25
+ "fooddata central",
26
+ "fdc",
27
+ "branded food",
28
+ "sr legacy",
29
+ "fndds",
30
+ "foundation foods",
31
+ "ingredients",
32
+ "serving size"
33
+ ],
34
+ "questions": [
35
+ "calories and protein in a food",
36
+ "sodium content of branded products",
37
+ "compare nutrients of several foods",
38
+ "vitamin content per 100 grams",
39
+ "nutrients of foods as eaten in NHANES (FNDDS)"
40
+ ],
41
+ "homepage": "https://fdc.nal.usda.gov/",
42
+ "terms_url": "https://fdc.nal.usda.gov/api-guide",
43
+ "auth": {
44
+ "env": "DATA_GOV_API_KEY",
45
+ "required": "optional",
46
+ "placement": "query",
47
+ "param": "api_key",
48
+ "home": "data-gov",
49
+ "signup_url": "https://fdc.nal.usda.gov/api-key-signup",
50
+ "echoes_key": false,
51
+ "key_only": [
52
+ "more than a few requests an hour (DEMO_KEY limits; a free key allows 1,000 an hour)"
53
+ ],
54
+ "demo_key": "DEMO_KEY"
55
+ },
56
+ "limits": {
57
+ "rps": 2,
58
+ "burst": 4,
59
+ "max_rows": 200000
60
+ },
61
+ "routes": {
62
+ "api": {
63
+ "base": "https://api.nal.usda.gov/fdc/v1",
64
+ "probe": "https://api.nal.usda.gov/fdc/v1/foods/search?query=apple&pageSize=1",
65
+ "hosts": [
66
+ "api.nal.usda.gov"
67
+ ]
68
+ },
69
+ "manual": {
70
+ "how": "Open the links in INSTRUCTIONS.md (they carry DEMO_KEY, which works in a browser for a few requests; replace it with your own api.data.gov key if refused), save each under the shown name and upload. For whole data types download CSV or JSON from https://fdc.nal.usda.gov/download-datasets, or search https://fdc.nal.usda.gov/food-search and download a food's data."
71
+ }
72
+ },
73
+ "cache": {
74
+ "mode": "run_only",
75
+ "ttl_hours": null,
76
+ "why": "Requests are small; FDC publishes new releases of each data type periodically (publishedDate per food). data/ is reused within a run."
77
+ },
78
+ "redistribution": {
79
+ "mode": "allowed",
80
+ "why": "FoodData Central data are in the public domain under CC0 1.0 (https://fdc.nal.usda.gov/api-guide, Licensing); USDA asks that FoodData Central be listed as the source."
81
+ },
82
+ "notices": [],
83
+ "retention": null,
84
+ "citation": "U.S. Department of Agriculture, Agricultural Research Service. FoodData Central: {dataset}. fdc.nal.usda.gov, retrieved {retrieved_long}.",
85
+ "audit_hooks": [],
86
+ "clarify": [
87
+ "Which data type: Foundation (generic foods, analytical values), SR Legacy (generic foods, final 2018 release), Survey (FNDDS, foods as eaten), or Branded (label values of specific products)?",
88
+ "Per 100 g (how FDC reports nutrients) or per serving? Per-serving values need the food's serving size or portion weight."
89
+ ],
90
+ "formats": [
91
+ "json",
92
+ "csv"
93
+ ]
94
+ }