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,82 +1,82 @@
1
- {
2
- "id": "nws",
3
- "title": "National Weather Service API (forecasts, alerts, observations)",
4
- "agency": "National Weather Service, National Oceanic and Atmospheric Administration",
5
- "depth": "standard",
6
- "domains": [
7
- "weather",
8
- "emergency management"
9
- ],
10
- "keywords": [
11
- "forecast",
12
- "weather forecast",
13
- "hourly forecast",
14
- "weather alert",
15
- "warning",
16
- "watch",
17
- "advisory",
18
- "tornado warning",
19
- "flood warning",
20
- "heat advisory",
21
- "winter storm",
22
- "current weather",
23
- "observation",
24
- "nws",
25
- "weather.gov"
26
- ],
27
- "questions": [
28
- "the 7-day forecast for a place",
29
- "active weather warnings in a state",
30
- "current conditions at an airport station",
31
- "alerts issued for a county in the last few days"
32
- ],
33
- "homepage": "https://www.weather.gov/documentation/services-web-api",
34
- "terms_url": "https://www.weather.gov/disclaimer",
35
- "auth": {
36
- "env": null,
37
- "required": "none",
38
- "placement": "none",
39
- "signup_url": null,
40
- "echoes_key": false
41
- },
42
- "limits": {
43
- "rps": 3,
44
- "burst": 6,
45
- "max_rows": 10000
46
- },
47
- "routes": {
48
- "api": {
49
- "base": "https://api.weather.gov",
50
- "probe": "https://api.weather.gov/alerts/types",
51
- "hosts": [
52
- "api.weather.gov"
53
- ]
54
- },
55
- "manual": {
56
- "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser and save the JSON under the name shown; for forecasts open the point link first, then the URL in its properties.forecast (or forecastHourly) field, and save that page. Upload the files. Without the links: https://forecast.weather.gov (type the place) shows the same forecast, and https://alerts.weather.gov lists active alerts."
57
- }
58
- },
59
- "cache": {
60
- "mode": "none",
61
- "ttl_hours": null,
62
- "why": "Forecasts update hourly and alerts by the minute; every run asks again."
63
- },
64
- "redistribution": {
65
- "mode": "allowed",
66
- "why": "NWS information is a U.S. government work in the public domain (17 U.S.C. 105; https://www.weather.gov/disclaimer); credit the National Weather Service."
67
- },
68
- "notices": [],
69
- "retention": {
70
- "upstream_days": 7,
71
- "note": "The API serves current forecasts, active alerts, recent alerts and about the last week of observations only; it is not an archive. Record the retrieval time."
72
- },
73
- "citation": "National Weather Service, {dataset}, api.weather.gov, retrieved {retrieved_long}.",
74
- "audit_hooks": [],
75
- "clarify": [
76
- "Forecast, current conditions, or past weather? Forecasts are not historical data; past weather comes from noaa (station observations) instead."
77
- ],
78
- "formats": [
79
- "json",
80
- "geojson"
81
- ]
82
- }
1
+ {
2
+ "id": "nws",
3
+ "title": "National Weather Service API (forecasts, alerts, observations)",
4
+ "agency": "National Weather Service, National Oceanic and Atmospheric Administration",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "weather",
8
+ "emergency management"
9
+ ],
10
+ "keywords": [
11
+ "forecast",
12
+ "weather forecast",
13
+ "hourly forecast",
14
+ "weather alert",
15
+ "warning",
16
+ "watch",
17
+ "advisory",
18
+ "tornado warning",
19
+ "flood warning",
20
+ "heat advisory",
21
+ "winter storm",
22
+ "current weather",
23
+ "observation",
24
+ "nws",
25
+ "weather.gov"
26
+ ],
27
+ "questions": [
28
+ "the 7-day forecast for a place",
29
+ "active weather warnings in a state",
30
+ "current conditions at an airport station",
31
+ "alerts issued for a county in the last few days"
32
+ ],
33
+ "homepage": "https://www.weather.gov/documentation/services-web-api",
34
+ "terms_url": "https://www.weather.gov/disclaimer",
35
+ "auth": {
36
+ "env": null,
37
+ "required": "none",
38
+ "placement": "none",
39
+ "signup_url": null,
40
+ "echoes_key": false
41
+ },
42
+ "limits": {
43
+ "rps": 3,
44
+ "burst": 6,
45
+ "max_rows": 10000
46
+ },
47
+ "routes": {
48
+ "api": {
49
+ "base": "https://api.weather.gov",
50
+ "probe": "https://api.weather.gov/alerts/types",
51
+ "hosts": [
52
+ "api.weather.gov"
53
+ ]
54
+ },
55
+ "manual": {
56
+ "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser and save the JSON under the name shown; for forecasts open the point link first, then the URL in its properties.forecast (or forecastHourly) field, and save that page. Upload the files. Without the links: https://forecast.weather.gov (type the place) shows the same forecast, and https://alerts.weather.gov lists active alerts."
57
+ }
58
+ },
59
+ "cache": {
60
+ "mode": "none",
61
+ "ttl_hours": null,
62
+ "why": "Forecasts update hourly and alerts by the minute; every run asks again."
63
+ },
64
+ "redistribution": {
65
+ "mode": "allowed",
66
+ "why": "NWS information is a U.S. government work in the public domain (17 U.S.C. 105; https://www.weather.gov/disclaimer); credit the National Weather Service."
67
+ },
68
+ "notices": [],
69
+ "retention": {
70
+ "upstream_days": 7,
71
+ "note": "The API serves current forecasts, active alerts, recent alerts and about the last week of observations only; it is not an archive. Record the retrieval time."
72
+ },
73
+ "citation": "National Weather Service, {dataset}, api.weather.gov, retrieved {retrieved_long}.",
74
+ "audit_hooks": [],
75
+ "clarify": [
76
+ "Forecast, current conditions, or past weather? Forecasts are not historical data; past weather comes from noaa (station observations) instead."
77
+ ],
78
+ "formats": [
79
+ "json",
80
+ "geojson"
81
+ ]
82
+ }
@@ -1,80 +1,80 @@
1
- {
2
- "base_url": "https://markets.newyorkfed.org/api",
3
- "timeout": 60,
4
- "endpoints": {
5
- "rates": {
6
- "path": "/rates/{family}/{ratetype}/search.json",
7
- "description": "Daily reference rate with percentiles and volume, one row per business day: secured (sofr, tgcr, bgcr) or unsecured (effr, obfr). Rows come newest first.",
8
- "params": {
9
- "family": {"in": "path", "required": true, "enum": ["secured", "unsecured"], "desc": "secured (SOFR, TGCR, BGCR) or unsecured (EFFR, OBFR)"},
10
- "ratetype": {"in": "path", "required": true, "enum": ["sofr", "tgcr", "bgcr", "effr", "obfr"], "desc": "rate name, lower case; it must belong to the family"},
11
- "startDate": {"desc": "first effective date, YYYY-MM-DD"},
12
- "endDate": {"desc": "last effective date, YYYY-MM-DD"}
13
- },
14
- "records": "refRates",
15
- "paging": {"type": "none"}
16
- },
17
- "soma_summary": {
18
- "path": "/soma/summary.json",
19
- "description": "Weekly (Wednesday) SOMA holdings totals in dollars by asset class (bills, notes and bonds, TIPS, FRN, MBS, agencies) since 2003-07-09: the whole history, about 1,200 rows.",
20
- "params": {},
21
- "records": "soma.summary",
22
- "paging": {"type": "none"}
23
- },
24
- "soma_tsy_holdings": {
25
- "path": "/soma/tsy/get/asof/{date}.json",
26
- "description": "SOMA Treasury holdings on one as-of date, one row per CUSIP: maturity date, coupon, par value, inflation compensation, share of the issue outstanding, security type (Bills, NotesBonds, TIPS, FRN).",
27
- "params": {
28
- "date": {"in": "path", "required": true, "desc": "an as-of date from soma_asofdates, YYYY-MM-DD"}
29
- },
30
- "records": "soma.holdings",
31
- "paging": {"type": "none"}
32
- },
33
- "soma_tsy_wam": {
34
- "path": "/soma/tsy/wam/{holdingtype}/asof/{date}.json",
35
- "description": "Weighted average maturity, in years, of the SOMA Treasury holdings on one as-of date. One row.",
36
- "params": {
37
- "holdingtype": {"in": "path", "required": true, "enum": ["all", "bills", "notesbonds", "tips", "frn"], "desc": "all, or one security type"},
38
- "date": {"in": "path", "required": true, "desc": "an as-of date from soma_asofdates, YYYY-MM-DD"}
39
- },
40
- "records": "soma",
41
- "paging": {"type": "none"}
42
- },
43
- "soma_asofdates": {
44
- "path": "/soma/asofdates/list.json",
45
- "description": "Every SOMA as-of date published, as one column (asOfDate).",
46
- "params": {},
47
- "records": "soma.asOfDates",
48
- "paging": {"type": "none"}
49
- },
50
- "tsy_operations": {
51
- "path": "/tsy/{operation}/results/{include}/search.json",
52
- "description": "Fed Treasury purchase or sale operations in a date range, one row per operation (include=summary) or with the securities bought as JSON text in a details column (include=details).",
53
- "params": {
54
- "operation": {"in": "path", "required": true, "enum": ["purchases", "sales", "all"], "desc": "purchases, sales or all"},
55
- "include": {"in": "path", "required": true, "enum": ["summary", "details"], "desc": "summary (one row per operation) or details (adds the securities)"},
56
- "startDate": {"desc": "first operation date, YYYY-MM-DD"},
57
- "endDate": {"desc": "last operation date, YYYY-MM-DD"}
58
- },
59
- "records": "treasury.auctions",
60
- "paging": {"type": "none"}
61
- },
62
- "pd_series": {
63
- "path": "/pd/get/{timeseries}.json",
64
- "description": "One primary dealer statistics series (positions, financing, transactions), weekly since 2013, in millions of dollars: one row per as-of date (asofdate, keyid, value).",
65
- "params": {
66
- "timeseries": {"in": "path", "required": true, "desc": "series key from pd_catalog, e.g. PDPOSGST-TOT (net Treasury positions)", "catalog": true}
67
- },
68
- "records": "pd.timeseries",
69
- "paging": {"type": "none"}
70
- },
71
- "pd_catalog": {
72
- "path": "/pd/list/timeseries.json",
73
- "description": "Every primary dealer series key with its series break and description (about 1,500 rows; search it for the key you need).",
74
- "params": {},
75
- "records": "pd.timeseries",
76
- "paging": {"type": "none"}
77
- }
78
- },
79
- "catalog": {}
80
- }
1
+ {
2
+ "base_url": "https://markets.newyorkfed.org/api",
3
+ "timeout": 60,
4
+ "endpoints": {
5
+ "rates": {
6
+ "path": "/rates/{family}/{ratetype}/search.json",
7
+ "description": "Daily reference rate with percentiles and volume, one row per business day: secured (sofr, tgcr, bgcr) or unsecured (effr, obfr). Rows come newest first.",
8
+ "params": {
9
+ "family": {"in": "path", "required": true, "enum": ["secured", "unsecured"], "desc": "secured (SOFR, TGCR, BGCR) or unsecured (EFFR, OBFR)"},
10
+ "ratetype": {"in": "path", "required": true, "enum": ["sofr", "tgcr", "bgcr", "effr", "obfr"], "desc": "rate name, lower case; it must belong to the family"},
11
+ "startDate": {"desc": "first effective date, YYYY-MM-DD"},
12
+ "endDate": {"desc": "last effective date, YYYY-MM-DD"}
13
+ },
14
+ "records": "refRates",
15
+ "paging": {"type": "none"}
16
+ },
17
+ "soma_summary": {
18
+ "path": "/soma/summary.json",
19
+ "description": "Weekly (Wednesday) SOMA holdings totals in dollars by asset class (bills, notes and bonds, TIPS, FRN, MBS, agencies) since 2003-07-09: the whole history, about 1,200 rows.",
20
+ "params": {},
21
+ "records": "soma.summary",
22
+ "paging": {"type": "none"}
23
+ },
24
+ "soma_tsy_holdings": {
25
+ "path": "/soma/tsy/get/asof/{date}.json",
26
+ "description": "SOMA Treasury holdings on one as-of date, one row per CUSIP: maturity date, coupon, par value, inflation compensation, share of the issue outstanding, security type (Bills, NotesBonds, TIPS, FRN).",
27
+ "params": {
28
+ "date": {"in": "path", "required": true, "desc": "an as-of date from soma_asofdates, YYYY-MM-DD"}
29
+ },
30
+ "records": "soma.holdings",
31
+ "paging": {"type": "none"}
32
+ },
33
+ "soma_tsy_wam": {
34
+ "path": "/soma/tsy/wam/{holdingtype}/asof/{date}.json",
35
+ "description": "Weighted average maturity, in years, of the SOMA Treasury holdings on one as-of date. One row.",
36
+ "params": {
37
+ "holdingtype": {"in": "path", "required": true, "enum": ["all", "bills", "notesbonds", "tips", "frn"], "desc": "all, or one security type"},
38
+ "date": {"in": "path", "required": true, "desc": "an as-of date from soma_asofdates, YYYY-MM-DD"}
39
+ },
40
+ "records": "soma",
41
+ "paging": {"type": "none"}
42
+ },
43
+ "soma_asofdates": {
44
+ "path": "/soma/asofdates/list.json",
45
+ "description": "Every SOMA as-of date published, as one column (asOfDate).",
46
+ "params": {},
47
+ "records": "soma.asOfDates",
48
+ "paging": {"type": "none"}
49
+ },
50
+ "tsy_operations": {
51
+ "path": "/tsy/{operation}/results/{include}/search.json",
52
+ "description": "Fed Treasury purchase or sale operations in a date range, one row per operation (include=summary) or with the securities bought as JSON text in a details column (include=details).",
53
+ "params": {
54
+ "operation": {"in": "path", "required": true, "enum": ["purchases", "sales", "all"], "desc": "purchases, sales or all"},
55
+ "include": {"in": "path", "required": true, "enum": ["summary", "details"], "desc": "summary (one row per operation) or details (adds the securities)"},
56
+ "startDate": {"desc": "first operation date, YYYY-MM-DD"},
57
+ "endDate": {"desc": "last operation date, YYYY-MM-DD"}
58
+ },
59
+ "records": "treasury.auctions",
60
+ "paging": {"type": "none"}
61
+ },
62
+ "pd_series": {
63
+ "path": "/pd/get/{timeseries}.json",
64
+ "description": "One primary dealer statistics series (positions, financing, transactions), weekly since 2013, in millions of dollars: one row per as-of date (asofdate, keyid, value).",
65
+ "params": {
66
+ "timeseries": {"in": "path", "required": true, "desc": "series key from pd_catalog, e.g. PDPOSGST-TOT (net Treasury positions)", "catalog": true}
67
+ },
68
+ "records": "pd.timeseries",
69
+ "paging": {"type": "none"}
70
+ },
71
+ "pd_catalog": {
72
+ "path": "/pd/list/timeseries.json",
73
+ "description": "Every primary dealer series key with its series break and description (about 1,500 rows; search it for the key you need).",
74
+ "params": {},
75
+ "records": "pd.timeseries",
76
+ "paging": {"type": "none"}
77
+ }
78
+ },
79
+ "catalog": {}
80
+ }
@@ -1,92 +1,92 @@
1
- {
2
- "id": "nyfed",
3
- "title": "New York Fed Markets Data API (reference rates, SOMA, Treasury operations, primary dealers)",
4
- "agency": "Federal Reserve Bank of New York",
5
- "depth": "standard",
6
- "domains": [
7
- "monetary policy",
8
- "interest rates",
9
- "federal debt financing",
10
- "financial conditions"
11
- ],
12
- "keywords": [
13
- "sofr",
14
- "effr",
15
- "federal funds rate",
16
- "effective federal funds rate",
17
- "obfr",
18
- "tgcr",
19
- "bgcr",
20
- "reference rate",
21
- "overnight rate",
22
- "soma",
23
- "system open market account",
24
- "fed holdings",
25
- "fed balance sheet",
26
- "treasury holdings",
27
- "quantitative tightening",
28
- "runoff",
29
- "reserve management purchases",
30
- "primary dealer",
31
- "dealer positions",
32
- "open market operations",
33
- "reverse repo",
34
- "debt service",
35
- "interest cost",
36
- "term premium",
37
- "monetary policy"
38
- ],
39
- "questions": [
40
- "how much of the Treasury debt does the Federal Reserve hold, by maturity",
41
- "SOFR and the effective federal funds rate over the last year, as an input to a debt-service projection",
42
- "weighted average maturity of the Fed's Treasury holdings",
43
- "Fed purchases of Treasury bills in recent weeks",
44
- "primary dealer net positions in Treasury securities"
45
- ],
46
- "homepage": "https://markets.newyorkfed.org/static/docs/markets-api.html",
47
- "terms_url": "https://www.newyorkfed.org/terms-of-use",
48
- "auth": {
49
- "env": null,
50
- "required": "none",
51
- "placement": "none",
52
- "signup_url": null,
53
- "echoes_key": false
54
- },
55
- "limits": {
56
- "rps": 1,
57
- "burst": 3,
58
- "max_rows": 100000
59
- },
60
- "routes": {
61
- "api": {
62
- "base": "https://markets.newyorkfed.org/api",
63
- "probe": "https://markets.newyorkfed.org/api/soma/asofdates/latest.json",
64
- "hosts": [
65
- "markets.newyorkfed.org"
66
- ]
67
- },
68
- "manual": {
69
- "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser and save the JSON page (File > Save as) under the name shown, then upload it. Without the links: reference rates at https://www.newyorkfed.org/markets/reference-rates, SOMA holdings at https://www.newyorkfed.org/markets/soma-holdings (Download), Treasury operations at https://www.newyorkfed.org/markets/desk-operations/treasury, primary dealer statistics at https://www.newyorkfed.org/markets/counterparties/primary-dealers-statistics."
70
- }
71
- },
72
- "cache": {
73
- "mode": "run_only",
74
- "ttl_hours": null,
75
- "why": "Rates and operations update daily, SOMA weekly; data/ is reused only within a run."
76
- },
77
- "redistribution": {
78
- "mode": "allowed",
79
- "why": "The Markets Data APIs are published openly by the Federal Reserve Bank of New York for public use; the Bank's terms of use allow use of its published data with attribution."
80
- },
81
- "notices": [],
82
- "retention": null,
83
- "citation": "Federal Reserve Bank of New York, Markets Data APIs ({dataset}), markets.newyorkfed.org, retrieved {retrieved_long}.",
84
- "audit_hooks": [],
85
- "clarify": [
86
- "Which rate: SOFR (secured, Treasury repo), EFFR (unsecured, the policy-rate benchmark) or another? Default: both, stated as separate series.",
87
- "Which date for SOMA holdings: the latest weekly as-of date, or a past date for a comparison? Default: the latest (see source.md for how to find it)."
88
- ],
89
- "formats": [
90
- "json"
91
- ]
92
- }
1
+ {
2
+ "id": "nyfed",
3
+ "title": "New York Fed Markets Data API (reference rates, SOMA, Treasury operations, primary dealers)",
4
+ "agency": "Federal Reserve Bank of New York",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "monetary policy",
8
+ "interest rates",
9
+ "federal debt financing",
10
+ "financial conditions"
11
+ ],
12
+ "keywords": [
13
+ "sofr",
14
+ "effr",
15
+ "federal funds rate",
16
+ "effective federal funds rate",
17
+ "obfr",
18
+ "tgcr",
19
+ "bgcr",
20
+ "reference rate",
21
+ "overnight rate",
22
+ "soma",
23
+ "system open market account",
24
+ "fed holdings",
25
+ "fed balance sheet",
26
+ "treasury holdings",
27
+ "quantitative tightening",
28
+ "runoff",
29
+ "reserve management purchases",
30
+ "primary dealer",
31
+ "dealer positions",
32
+ "open market operations",
33
+ "reverse repo",
34
+ "debt service",
35
+ "interest cost",
36
+ "term premium",
37
+ "monetary policy"
38
+ ],
39
+ "questions": [
40
+ "how much of the Treasury debt does the Federal Reserve hold, by maturity",
41
+ "SOFR and the effective federal funds rate over the last year, as an input to a debt-service projection",
42
+ "weighted average maturity of the Fed's Treasury holdings",
43
+ "Fed purchases of Treasury bills in recent weeks",
44
+ "primary dealer net positions in Treasury securities"
45
+ ],
46
+ "homepage": "https://markets.newyorkfed.org/static/docs/markets-api.html",
47
+ "terms_url": "https://www.newyorkfed.org/terms-of-use",
48
+ "auth": {
49
+ "env": null,
50
+ "required": "none",
51
+ "placement": "none",
52
+ "signup_url": null,
53
+ "echoes_key": false
54
+ },
55
+ "limits": {
56
+ "rps": 1,
57
+ "burst": 3,
58
+ "max_rows": 100000
59
+ },
60
+ "routes": {
61
+ "api": {
62
+ "base": "https://markets.newyorkfed.org/api",
63
+ "probe": "https://markets.newyorkfed.org/api/soma/asofdates/latest.json",
64
+ "hosts": [
65
+ "markets.newyorkfed.org"
66
+ ]
67
+ },
68
+ "manual": {
69
+ "how": "Open each link in manual_download/INSTRUCTIONS.md in a browser and save the JSON page (File > Save as) under the name shown, then upload it. Without the links: reference rates at https://www.newyorkfed.org/markets/reference-rates, SOMA holdings at https://www.newyorkfed.org/markets/soma-holdings (Download), Treasury operations at https://www.newyorkfed.org/markets/desk-operations/treasury, primary dealer statistics at https://www.newyorkfed.org/markets/counterparties/primary-dealers-statistics."
70
+ }
71
+ },
72
+ "cache": {
73
+ "mode": "run_only",
74
+ "ttl_hours": null,
75
+ "why": "Rates and operations update daily, SOMA weekly; data/ is reused only within a run."
76
+ },
77
+ "redistribution": {
78
+ "mode": "allowed",
79
+ "why": "The Markets Data APIs are published openly by the Federal Reserve Bank of New York for public use; the Bank's terms of use allow use of its published data with attribution."
80
+ },
81
+ "notices": [],
82
+ "retention": null,
83
+ "citation": "Federal Reserve Bank of New York, Markets Data APIs ({dataset}), markets.newyorkfed.org, retrieved {retrieved_long}.",
84
+ "audit_hooks": [],
85
+ "clarify": [
86
+ "Which rate: SOFR (secured, Treasury repo), EFFR (unsecured, the policy-rate benchmark) or another? Default: both, stated as separate series.",
87
+ "Which date for SOMA holdings: the latest weekly as-of date, or a past date for a comparison? Default: the latest (see source.md for how to find it)."
88
+ ],
89
+ "formats": [
90
+ "json"
91
+ ]
92
+ }