@clear-street/clearstreet 0.0.0 → 0.73.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 (579) hide show
  1. package/CHANGELOG.md +994 -0
  2. package/LICENSE +201 -0
  3. package/README.md +358 -0
  4. package/api-promise.d.mts +3 -0
  5. package/api-promise.d.mts.map +1 -0
  6. package/api-promise.d.ts +3 -0
  7. package/api-promise.d.ts.map +1 -0
  8. package/api-promise.js +6 -0
  9. package/api-promise.js.map +1 -0
  10. package/api-promise.mjs +3 -0
  11. package/api-promise.mjs.map +1 -0
  12. package/client.d.mts +195 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +195 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +489 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +485 -0
  19. package/client.mjs.map +1 -0
  20. package/core/api-promise.d.mts +46 -0
  21. package/core/api-promise.d.mts.map +1 -0
  22. package/core/api-promise.d.ts +46 -0
  23. package/core/api-promise.d.ts.map +1 -0
  24. package/core/api-promise.js +74 -0
  25. package/core/api-promise.js.map +1 -0
  26. package/core/api-promise.mjs +70 -0
  27. package/core/api-promise.mjs.map +1 -0
  28. package/core/error.d.mts +46 -0
  29. package/core/error.d.mts.map +1 -0
  30. package/core/error.d.ts +46 -0
  31. package/core/error.d.ts.map +1 -0
  32. package/core/error.js +113 -0
  33. package/core/error.js.map +1 -0
  34. package/core/error.mjs +97 -0
  35. package/core/error.mjs.map +1 -0
  36. package/core/resource.d.mts +6 -0
  37. package/core/resource.d.mts.map +1 -0
  38. package/core/resource.d.ts +6 -0
  39. package/core/resource.d.ts.map +1 -0
  40. package/core/resource.js +11 -0
  41. package/core/resource.js.map +1 -0
  42. package/core/resource.mjs +7 -0
  43. package/core/resource.mjs.map +1 -0
  44. package/core/uploads.d.mts +3 -0
  45. package/core/uploads.d.mts.map +1 -0
  46. package/core/uploads.d.ts +3 -0
  47. package/core/uploads.d.ts.map +1 -0
  48. package/core/uploads.js +6 -0
  49. package/core/uploads.js.map +1 -0
  50. package/core/uploads.mjs +2 -0
  51. package/core/uploads.mjs.map +1 -0
  52. package/error.d.mts +3 -0
  53. package/error.d.mts.map +1 -0
  54. package/error.d.ts +3 -0
  55. package/error.d.ts.map +1 -0
  56. package/error.js +6 -0
  57. package/error.js.map +1 -0
  58. package/error.mjs +3 -0
  59. package/error.mjs.map +1 -0
  60. package/index.d.mts +6 -0
  61. package/index.d.mts.map +1 -0
  62. package/index.d.ts +6 -0
  63. package/index.d.ts.map +1 -0
  64. package/index.js +30 -0
  65. package/index.js.map +1 -0
  66. package/index.mjs +7 -0
  67. package/index.mjs.map +1 -0
  68. package/internal/builtin-types.d.mts +73 -0
  69. package/internal/builtin-types.d.mts.map +1 -0
  70. package/internal/builtin-types.d.ts +73 -0
  71. package/internal/builtin-types.d.ts.map +1 -0
  72. package/internal/builtin-types.js +4 -0
  73. package/internal/builtin-types.js.map +1 -0
  74. package/internal/builtin-types.mjs +3 -0
  75. package/internal/builtin-types.mjs.map +1 -0
  76. package/internal/detect-platform.d.mts +15 -0
  77. package/internal/detect-platform.d.mts.map +1 -0
  78. package/internal/detect-platform.d.ts +15 -0
  79. package/internal/detect-platform.d.ts.map +1 -0
  80. package/internal/detect-platform.js +162 -0
  81. package/internal/detect-platform.js.map +1 -0
  82. package/internal/detect-platform.mjs +157 -0
  83. package/internal/detect-platform.mjs.map +1 -0
  84. package/internal/errors.d.mts +3 -0
  85. package/internal/errors.d.mts.map +1 -0
  86. package/internal/errors.d.ts +3 -0
  87. package/internal/errors.d.ts.map +1 -0
  88. package/internal/errors.js +41 -0
  89. package/internal/errors.js.map +1 -0
  90. package/internal/errors.mjs +36 -0
  91. package/internal/errors.mjs.map +1 -0
  92. package/internal/headers.d.mts +20 -0
  93. package/internal/headers.d.mts.map +1 -0
  94. package/internal/headers.d.ts +20 -0
  95. package/internal/headers.d.ts.map +1 -0
  96. package/internal/headers.js +79 -0
  97. package/internal/headers.js.map +1 -0
  98. package/internal/headers.mjs +74 -0
  99. package/internal/headers.mjs.map +1 -0
  100. package/internal/parse.d.mts +12 -0
  101. package/internal/parse.d.mts.map +1 -0
  102. package/internal/parse.d.ts +12 -0
  103. package/internal/parse.d.ts.map +1 -0
  104. package/internal/parse.js +40 -0
  105. package/internal/parse.js.map +1 -0
  106. package/internal/parse.mjs +37 -0
  107. package/internal/parse.mjs.map +1 -0
  108. package/internal/qs/formats.d.mts +7 -0
  109. package/internal/qs/formats.d.mts.map +1 -0
  110. package/internal/qs/formats.d.ts +7 -0
  111. package/internal/qs/formats.d.ts.map +1 -0
  112. package/internal/qs/formats.js +13 -0
  113. package/internal/qs/formats.js.map +1 -0
  114. package/internal/qs/formats.mjs +9 -0
  115. package/internal/qs/formats.mjs.map +1 -0
  116. package/internal/qs/index.d.mts +10 -0
  117. package/internal/qs/index.d.mts.map +1 -0
  118. package/internal/qs/index.d.ts +10 -0
  119. package/internal/qs/index.d.ts.map +1 -0
  120. package/internal/qs/index.js +14 -0
  121. package/internal/qs/index.js.map +1 -0
  122. package/internal/qs/index.mjs +10 -0
  123. package/internal/qs/index.mjs.map +1 -0
  124. package/internal/qs/stringify.d.mts +3 -0
  125. package/internal/qs/stringify.d.mts.map +1 -0
  126. package/internal/qs/stringify.d.ts +3 -0
  127. package/internal/qs/stringify.d.ts.map +1 -0
  128. package/internal/qs/stringify.js +277 -0
  129. package/internal/qs/stringify.js.map +1 -0
  130. package/internal/qs/stringify.mjs +274 -0
  131. package/internal/qs/stringify.mjs.map +1 -0
  132. package/internal/qs/types.d.mts +57 -0
  133. package/internal/qs/types.d.mts.map +1 -0
  134. package/internal/qs/types.d.ts +57 -0
  135. package/internal/qs/types.d.ts.map +1 -0
  136. package/internal/qs/types.js +3 -0
  137. package/internal/qs/types.js.map +1 -0
  138. package/internal/qs/types.mjs +2 -0
  139. package/internal/qs/types.mjs.map +1 -0
  140. package/internal/qs/utils.d.mts +15 -0
  141. package/internal/qs/utils.d.mts.map +1 -0
  142. package/internal/qs/utils.d.ts +15 -0
  143. package/internal/qs/utils.d.ts.map +1 -0
  144. package/internal/qs/utils.js +230 -0
  145. package/internal/qs/utils.js.map +1 -0
  146. package/internal/qs/utils.mjs +217 -0
  147. package/internal/qs/utils.mjs.map +1 -0
  148. package/internal/request-options.d.mts +75 -0
  149. package/internal/request-options.d.mts.map +1 -0
  150. package/internal/request-options.d.ts +75 -0
  151. package/internal/request-options.d.ts.map +1 -0
  152. package/internal/request-options.js +14 -0
  153. package/internal/request-options.js.map +1 -0
  154. package/internal/request-options.mjs +10 -0
  155. package/internal/request-options.mjs.map +1 -0
  156. package/internal/shim-types.d.mts +17 -0
  157. package/internal/shim-types.d.mts.map +1 -0
  158. package/internal/shim-types.d.ts +17 -0
  159. package/internal/shim-types.d.ts.map +1 -0
  160. package/internal/shim-types.js +4 -0
  161. package/internal/shim-types.js.map +1 -0
  162. package/internal/shim-types.mjs +3 -0
  163. package/internal/shim-types.mjs.map +1 -0
  164. package/internal/shims.d.mts +26 -0
  165. package/internal/shims.d.mts.map +1 -0
  166. package/internal/shims.d.ts +26 -0
  167. package/internal/shims.d.ts.map +1 -0
  168. package/internal/shims.js +92 -0
  169. package/internal/shims.js.map +1 -0
  170. package/internal/shims.mjs +85 -0
  171. package/internal/shims.mjs.map +1 -0
  172. package/internal/to-file.d.mts +45 -0
  173. package/internal/to-file.d.mts.map +1 -0
  174. package/internal/to-file.d.ts +45 -0
  175. package/internal/to-file.d.ts.map +1 -0
  176. package/internal/to-file.js +91 -0
  177. package/internal/to-file.js.map +1 -0
  178. package/internal/to-file.mjs +88 -0
  179. package/internal/to-file.mjs.map +1 -0
  180. package/internal/tslib.js +81 -0
  181. package/internal/tslib.mjs +17 -0
  182. package/internal/types.d.mts +69 -0
  183. package/internal/types.d.mts.map +1 -0
  184. package/internal/types.d.ts +69 -0
  185. package/internal/types.d.ts.map +1 -0
  186. package/internal/types.js +4 -0
  187. package/internal/types.js.map +1 -0
  188. package/internal/types.mjs +3 -0
  189. package/internal/types.mjs.map +1 -0
  190. package/internal/uploads.d.mts +42 -0
  191. package/internal/uploads.d.mts.map +1 -0
  192. package/internal/uploads.d.ts +42 -0
  193. package/internal/uploads.d.ts.map +1 -0
  194. package/internal/uploads.js +141 -0
  195. package/internal/uploads.js.map +1 -0
  196. package/internal/uploads.mjs +131 -0
  197. package/internal/uploads.mjs.map +1 -0
  198. package/internal/utils/base64.d.mts +3 -0
  199. package/internal/utils/base64.d.mts.map +1 -0
  200. package/internal/utils/base64.d.ts +3 -0
  201. package/internal/utils/base64.d.ts.map +1 -0
  202. package/internal/utils/base64.js +38 -0
  203. package/internal/utils/base64.js.map +1 -0
  204. package/internal/utils/base64.mjs +33 -0
  205. package/internal/utils/base64.mjs.map +1 -0
  206. package/internal/utils/bytes.d.mts +4 -0
  207. package/internal/utils/bytes.d.mts.map +1 -0
  208. package/internal/utils/bytes.d.ts +4 -0
  209. package/internal/utils/bytes.d.ts.map +1 -0
  210. package/internal/utils/bytes.js +31 -0
  211. package/internal/utils/bytes.js.map +1 -0
  212. package/internal/utils/bytes.mjs +26 -0
  213. package/internal/utils/bytes.mjs.map +1 -0
  214. package/internal/utils/env.d.mts +9 -0
  215. package/internal/utils/env.d.mts.map +1 -0
  216. package/internal/utils/env.d.ts +9 -0
  217. package/internal/utils/env.d.ts.map +1 -0
  218. package/internal/utils/env.js +22 -0
  219. package/internal/utils/env.js.map +1 -0
  220. package/internal/utils/env.mjs +18 -0
  221. package/internal/utils/env.mjs.map +1 -0
  222. package/internal/utils/log.d.mts +37 -0
  223. package/internal/utils/log.d.mts.map +1 -0
  224. package/internal/utils/log.d.ts +37 -0
  225. package/internal/utils/log.d.ts.map +1 -0
  226. package/internal/utils/log.js +87 -0
  227. package/internal/utils/log.js.map +1 -0
  228. package/internal/utils/log.mjs +81 -0
  229. package/internal/utils/log.mjs.map +1 -0
  230. package/internal/utils/path.d.mts +15 -0
  231. package/internal/utils/path.d.mts.map +1 -0
  232. package/internal/utils/path.d.ts +15 -0
  233. package/internal/utils/path.d.ts.map +1 -0
  234. package/internal/utils/path.js +79 -0
  235. package/internal/utils/path.js.map +1 -0
  236. package/internal/utils/path.mjs +74 -0
  237. package/internal/utils/path.mjs.map +1 -0
  238. package/internal/utils/query.d.mts +2 -0
  239. package/internal/utils/query.d.mts.map +1 -0
  240. package/internal/utils/query.d.ts +2 -0
  241. package/internal/utils/query.d.ts.map +1 -0
  242. package/internal/utils/query.js +10 -0
  243. package/internal/utils/query.js.map +1 -0
  244. package/internal/utils/query.mjs +6 -0
  245. package/internal/utils/query.mjs.map +1 -0
  246. package/internal/utils/sleep.d.mts +2 -0
  247. package/internal/utils/sleep.d.mts.map +1 -0
  248. package/internal/utils/sleep.d.ts +2 -0
  249. package/internal/utils/sleep.d.ts.map +1 -0
  250. package/internal/utils/sleep.js +7 -0
  251. package/internal/utils/sleep.js.map +1 -0
  252. package/internal/utils/sleep.mjs +3 -0
  253. package/internal/utils/sleep.mjs.map +1 -0
  254. package/internal/utils/uuid.d.mts +5 -0
  255. package/internal/utils/uuid.d.mts.map +1 -0
  256. package/internal/utils/uuid.d.ts +5 -0
  257. package/internal/utils/uuid.d.ts.map +1 -0
  258. package/internal/utils/uuid.js +19 -0
  259. package/internal/utils/uuid.js.map +1 -0
  260. package/internal/utils/uuid.mjs +15 -0
  261. package/internal/utils/uuid.mjs.map +1 -0
  262. package/internal/utils/values.d.mts +18 -0
  263. package/internal/utils/values.d.mts.map +1 -0
  264. package/internal/utils/values.d.ts +18 -0
  265. package/internal/utils/values.d.ts.map +1 -0
  266. package/internal/utils/values.js +112 -0
  267. package/internal/utils/values.js.map +1 -0
  268. package/internal/utils/values.mjs +94 -0
  269. package/internal/utils/values.mjs.map +1 -0
  270. package/internal/utils.d.mts +8 -0
  271. package/internal/utils.d.mts.map +1 -0
  272. package/internal/utils.d.ts +8 -0
  273. package/internal/utils.d.ts.map +1 -0
  274. package/internal/utils.js +12 -0
  275. package/internal/utils.js.map +1 -0
  276. package/internal/utils.mjs +9 -0
  277. package/internal/utils.mjs.map +1 -0
  278. package/package.json +147 -3
  279. package/resource.d.mts +3 -0
  280. package/resource.d.mts.map +1 -0
  281. package/resource.d.ts +3 -0
  282. package/resource.d.ts.map +1 -0
  283. package/resource.js +6 -0
  284. package/resource.js.map +1 -0
  285. package/resource.mjs +3 -0
  286. package/resource.mjs.map +1 -0
  287. package/resources/index.d.mts +3 -0
  288. package/resources/index.d.mts.map +1 -0
  289. package/resources/index.d.ts +3 -0
  290. package/resources/index.d.ts.map +1 -0
  291. package/resources/index.js +9 -0
  292. package/resources/index.js.map +1 -0
  293. package/resources/index.mjs +4 -0
  294. package/resources/index.mjs.map +1 -0
  295. package/resources/shared.d.mts +63 -0
  296. package/resources/shared.d.mts.map +1 -0
  297. package/resources/shared.d.ts +63 -0
  298. package/resources/shared.d.ts.map +1 -0
  299. package/resources/shared.js +4 -0
  300. package/resources/shared.js.map +1 -0
  301. package/resources/shared.mjs +3 -0
  302. package/resources/shared.mjs.map +1 -0
  303. package/resources/v1/accounts.d.mts +436 -0
  304. package/resources/v1/accounts.d.mts.map +1 -0
  305. package/resources/v1/accounts.d.ts +436 -0
  306. package/resources/v1/accounts.d.ts.map +1 -0
  307. package/resources/v1/accounts.js +74 -0
  308. package/resources/v1/accounts.js.map +1 -0
  309. package/resources/v1/accounts.mjs +70 -0
  310. package/resources/v1/accounts.mjs.map +1 -0
  311. package/resources/v1/api-version.d.mts +37 -0
  312. package/resources/v1/api-version.d.mts.map +1 -0
  313. package/resources/v1/api-version.d.ts +37 -0
  314. package/resources/v1/api-version.d.ts.map +1 -0
  315. package/resources/v1/api-version.js +23 -0
  316. package/resources/v1/api-version.js.map +1 -0
  317. package/resources/v1/api-version.mjs +19 -0
  318. package/resources/v1/api-version.mjs.map +1 -0
  319. package/resources/v1/calendar.d.mts +170 -0
  320. package/resources/v1/calendar.d.mts.map +1 -0
  321. package/resources/v1/calendar.d.ts +170 -0
  322. package/resources/v1/calendar.d.ts.map +1 -0
  323. package/resources/v1/calendar.js +39 -0
  324. package/resources/v1/calendar.js.map +1 -0
  325. package/resources/v1/calendar.mjs +35 -0
  326. package/resources/v1/calendar.mjs.map +1 -0
  327. package/resources/v1/index.d.mts +12 -0
  328. package/resources/v1/index.d.mts.map +1 -0
  329. package/resources/v1/index.d.ts +12 -0
  330. package/resources/v1/index.d.ts.map +1 -0
  331. package/resources/v1/index.js +27 -0
  332. package/resources/v1/index.js.map +1 -0
  333. package/resources/v1/index.mjs +13 -0
  334. package/resources/v1/index.mjs.map +1 -0
  335. package/resources/v1/instrument-data/index.d.mts +4 -0
  336. package/resources/v1/instrument-data/index.d.mts.map +1 -0
  337. package/resources/v1/instrument-data/index.d.ts +4 -0
  338. package/resources/v1/instrument-data/index.d.ts.map +1 -0
  339. package/resources/v1/instrument-data/index.js +11 -0
  340. package/resources/v1/instrument-data/index.js.map +1 -0
  341. package/resources/v1/instrument-data/index.mjs +5 -0
  342. package/resources/v1/instrument-data/index.mjs.map +1 -0
  343. package/resources/v1/instrument-data/instrument-data.d.mts +1202 -0
  344. package/resources/v1/instrument-data/instrument-data.d.mts.map +1 -0
  345. package/resources/v1/instrument-data/instrument-data.d.ts +1202 -0
  346. package/resources/v1/instrument-data/instrument-data.d.ts.map +1 -0
  347. package/resources/v1/instrument-data/instrument-data.js +150 -0
  348. package/resources/v1/instrument-data/instrument-data.js.map +1 -0
  349. package/resources/v1/instrument-data/instrument-data.mjs +145 -0
  350. package/resources/v1/instrument-data/instrument-data.mjs.map +1 -0
  351. package/resources/v1/instrument-data/market-data.d.mts +240 -0
  352. package/resources/v1/instrument-data/market-data.d.mts.map +1 -0
  353. package/resources/v1/instrument-data/market-data.d.ts +240 -0
  354. package/resources/v1/instrument-data/market-data.d.ts.map +1 -0
  355. package/resources/v1/instrument-data/market-data.js +49 -0
  356. package/resources/v1/instrument-data/market-data.js.map +1 -0
  357. package/resources/v1/instrument-data/market-data.mjs +45 -0
  358. package/resources/v1/instrument-data/market-data.mjs.map +1 -0
  359. package/resources/v1/instrument-data/news.d.mts +136 -0
  360. package/resources/v1/instrument-data/news.d.mts.map +1 -0
  361. package/resources/v1/instrument-data/news.d.ts +136 -0
  362. package/resources/v1/instrument-data/news.d.ts.map +1 -0
  363. package/resources/v1/instrument-data/news.js +25 -0
  364. package/resources/v1/instrument-data/news.js.map +1 -0
  365. package/resources/v1/instrument-data/news.mjs +21 -0
  366. package/resources/v1/instrument-data/news.mjs.map +1 -0
  367. package/resources/v1/instrument-data.d.mts +2 -0
  368. package/resources/v1/instrument-data.d.mts.map +1 -0
  369. package/resources/v1/instrument-data.d.ts +2 -0
  370. package/resources/v1/instrument-data.d.ts.map +1 -0
  371. package/resources/v1/instrument-data.js +6 -0
  372. package/resources/v1/instrument-data.js.map +1 -0
  373. package/resources/v1/instrument-data.mjs +3 -0
  374. package/resources/v1/instrument-data.mjs.map +1 -0
  375. package/resources/v1/instruments.d.mts +473 -0
  376. package/resources/v1/instruments.d.mts.map +1 -0
  377. package/resources/v1/instruments.d.ts +473 -0
  378. package/resources/v1/instruments.d.ts.map +1 -0
  379. package/resources/v1/instruments.js +77 -0
  380. package/resources/v1/instruments.js.map +1 -0
  381. package/resources/v1/instruments.mjs +73 -0
  382. package/resources/v1/instruments.mjs.map +1 -0
  383. package/resources/v1/omni-ai/entitlements.d.mts +108 -0
  384. package/resources/v1/omni-ai/entitlements.d.mts.map +1 -0
  385. package/resources/v1/omni-ai/entitlements.d.ts +108 -0
  386. package/resources/v1/omni-ai/entitlements.d.ts.map +1 -0
  387. package/resources/v1/omni-ai/entitlements.js +67 -0
  388. package/resources/v1/omni-ai/entitlements.js.map +1 -0
  389. package/resources/v1/omni-ai/entitlements.mjs +63 -0
  390. package/resources/v1/omni-ai/entitlements.mjs.map +1 -0
  391. package/resources/v1/omni-ai/index.d.mts +6 -0
  392. package/resources/v1/omni-ai/index.d.mts.map +1 -0
  393. package/resources/v1/omni-ai/index.d.ts +6 -0
  394. package/resources/v1/omni-ai/index.d.ts.map +1 -0
  395. package/resources/v1/omni-ai/index.js +15 -0
  396. package/resources/v1/omni-ai/index.js.map +1 -0
  397. package/resources/v1/omni-ai/index.mjs +7 -0
  398. package/resources/v1/omni-ai/index.mjs.map +1 -0
  399. package/resources/v1/omni-ai/messages.d.mts +85 -0
  400. package/resources/v1/omni-ai/messages.d.mts.map +1 -0
  401. package/resources/v1/omni-ai/messages.d.ts +85 -0
  402. package/resources/v1/omni-ai/messages.d.ts.map +1 -0
  403. package/resources/v1/omni-ai/messages.js +51 -0
  404. package/resources/v1/omni-ai/messages.js.map +1 -0
  405. package/resources/v1/omni-ai/messages.mjs +47 -0
  406. package/resources/v1/omni-ai/messages.mjs.map +1 -0
  407. package/resources/v1/omni-ai/omni-ai.d.mts +323 -0
  408. package/resources/v1/omni-ai/omni-ai.d.mts.map +1 -0
  409. package/resources/v1/omni-ai/omni-ai.d.ts +323 -0
  410. package/resources/v1/omni-ai/omni-ai.d.ts.map +1 -0
  411. package/resources/v1/omni-ai/omni-ai.js +29 -0
  412. package/resources/v1/omni-ai/omni-ai.js.map +1 -0
  413. package/resources/v1/omni-ai/omni-ai.mjs +24 -0
  414. package/resources/v1/omni-ai/omni-ai.mjs.map +1 -0
  415. package/resources/v1/omni-ai/responses.d.mts +158 -0
  416. package/resources/v1/omni-ai/responses.d.mts.map +1 -0
  417. package/resources/v1/omni-ai/responses.d.ts +158 -0
  418. package/resources/v1/omni-ai/responses.d.ts.map +1 -0
  419. package/resources/v1/omni-ai/responses.js +60 -0
  420. package/resources/v1/omni-ai/responses.js.map +1 -0
  421. package/resources/v1/omni-ai/responses.mjs +56 -0
  422. package/resources/v1/omni-ai/responses.mjs.map +1 -0
  423. package/resources/v1/omni-ai/threads.d.mts +338 -0
  424. package/resources/v1/omni-ai/threads.d.mts.map +1 -0
  425. package/resources/v1/omni-ai/threads.d.ts +338 -0
  426. package/resources/v1/omni-ai/threads.d.ts.map +1 -0
  427. package/resources/v1/omni-ai/threads.js +141 -0
  428. package/resources/v1/omni-ai/threads.js.map +1 -0
  429. package/resources/v1/omni-ai/threads.mjs +137 -0
  430. package/resources/v1/omni-ai/threads.mjs.map +1 -0
  431. package/resources/v1/omni-ai.d.mts +2 -0
  432. package/resources/v1/omni-ai.d.mts.map +1 -0
  433. package/resources/v1/omni-ai.d.ts +2 -0
  434. package/resources/v1/omni-ai.d.ts.map +1 -0
  435. package/resources/v1/omni-ai.js +6 -0
  436. package/resources/v1/omni-ai.js.map +1 -0
  437. package/resources/v1/omni-ai.mjs +3 -0
  438. package/resources/v1/omni-ai.mjs.map +1 -0
  439. package/resources/v1/orders.d.mts +643 -0
  440. package/resources/v1/orders.d.mts.map +1 -0
  441. package/resources/v1/orders.d.ts +643 -0
  442. package/resources/v1/orders.d.ts.map +1 -0
  443. package/resources/v1/orders.js +134 -0
  444. package/resources/v1/orders.js.map +1 -0
  445. package/resources/v1/orders.mjs +130 -0
  446. package/resources/v1/orders.mjs.map +1 -0
  447. package/resources/v1/positions.d.mts +385 -0
  448. package/resources/v1/positions.d.mts.map +1 -0
  449. package/resources/v1/positions.d.ts +385 -0
  450. package/resources/v1/positions.d.ts.map +1 -0
  451. package/resources/v1/positions.js +130 -0
  452. package/resources/v1/positions.js.map +1 -0
  453. package/resources/v1/positions.mjs +126 -0
  454. package/resources/v1/positions.mjs.map +1 -0
  455. package/resources/v1/v1.d.mts +51 -0
  456. package/resources/v1/v1.d.mts.map +1 -0
  457. package/resources/v1/v1.d.ts +51 -0
  458. package/resources/v1/v1.d.ts.map +1 -0
  459. package/resources/v1/v1.js +53 -0
  460. package/resources/v1/v1.js.map +1 -0
  461. package/resources/v1/v1.mjs +48 -0
  462. package/resources/v1/v1.mjs.map +1 -0
  463. package/resources/v1/watchlist.d.mts +210 -0
  464. package/resources/v1/watchlist.d.mts.map +1 -0
  465. package/resources/v1/watchlist.d.ts +210 -0
  466. package/resources/v1/watchlist.d.ts.map +1 -0
  467. package/resources/v1/watchlist.js +95 -0
  468. package/resources/v1/watchlist.js.map +1 -0
  469. package/resources/v1/watchlist.mjs +91 -0
  470. package/resources/v1/watchlist.mjs.map +1 -0
  471. package/resources/v1/websocket.d.mts +18 -0
  472. package/resources/v1/websocket.d.mts.map +1 -0
  473. package/resources/v1/websocket.d.ts +18 -0
  474. package/resources/v1/websocket.d.ts.map +1 -0
  475. package/resources/v1/websocket.js +27 -0
  476. package/resources/v1/websocket.js.map +1 -0
  477. package/resources/v1/websocket.mjs +23 -0
  478. package/resources/v1/websocket.mjs.map +1 -0
  479. package/resources/v1.d.mts +2 -0
  480. package/resources/v1.d.mts.map +1 -0
  481. package/resources/v1.d.ts +2 -0
  482. package/resources/v1.d.ts.map +1 -0
  483. package/resources/v1.js +6 -0
  484. package/resources/v1.js.map +1 -0
  485. package/resources/v1.mjs +3 -0
  486. package/resources/v1.mjs.map +1 -0
  487. package/resources.d.mts +2 -0
  488. package/resources.d.mts.map +1 -0
  489. package/resources.d.ts +2 -0
  490. package/resources.d.ts.map +1 -0
  491. package/resources.js +5 -0
  492. package/resources.js.map +1 -0
  493. package/resources.mjs +2 -0
  494. package/resources.mjs.map +1 -0
  495. package/src/api-promise.ts +2 -0
  496. package/src/client.ts +769 -0
  497. package/src/core/README.md +3 -0
  498. package/src/core/api-promise.ts +92 -0
  499. package/src/core/error.ts +130 -0
  500. package/src/core/resource.ts +11 -0
  501. package/src/core/uploads.ts +2 -0
  502. package/src/error.ts +2 -0
  503. package/src/index.ts +22 -0
  504. package/src/internal/README.md +3 -0
  505. package/src/internal/builtin-types.ts +93 -0
  506. package/src/internal/detect-platform.ts +196 -0
  507. package/src/internal/errors.ts +33 -0
  508. package/src/internal/headers.ts +97 -0
  509. package/src/internal/parse.ts +56 -0
  510. package/src/internal/qs/LICENSE.md +13 -0
  511. package/src/internal/qs/README.md +3 -0
  512. package/src/internal/qs/formats.ts +10 -0
  513. package/src/internal/qs/index.ts +13 -0
  514. package/src/internal/qs/stringify.ts +385 -0
  515. package/src/internal/qs/types.ts +71 -0
  516. package/src/internal/qs/utils.ts +265 -0
  517. package/src/internal/request-options.ts +91 -0
  518. package/src/internal/shim-types.ts +26 -0
  519. package/src/internal/shims.ts +107 -0
  520. package/src/internal/to-file.ts +154 -0
  521. package/src/internal/types.ts +93 -0
  522. package/src/internal/uploads.ts +187 -0
  523. package/src/internal/utils/base64.ts +40 -0
  524. package/src/internal/utils/bytes.ts +32 -0
  525. package/src/internal/utils/env.ts +18 -0
  526. package/src/internal/utils/log.ts +128 -0
  527. package/src/internal/utils/path.ts +88 -0
  528. package/src/internal/utils/query.ts +7 -0
  529. package/src/internal/utils/sleep.ts +3 -0
  530. package/src/internal/utils/uuid.ts +17 -0
  531. package/src/internal/utils/values.ts +105 -0
  532. package/src/internal/utils.ts +9 -0
  533. package/src/lib/.keep +4 -0
  534. package/src/resource.ts +2 -0
  535. package/src/resources/index.ts +4 -0
  536. package/src/resources/shared.ts +72 -0
  537. package/src/resources/v1/accounts.ts +586 -0
  538. package/src/resources/v1/api-version.ts +44 -0
  539. package/src/resources/v1/calendar.ts +221 -0
  540. package/src/resources/v1/index.ts +203 -0
  541. package/src/resources/v1/instrument-data/index.ts +63 -0
  542. package/src/resources/v1/instrument-data/instrument-data.ts +1584 -0
  543. package/src/resources/v1/instrument-data/market-data.ts +306 -0
  544. package/src/resources/v1/instrument-data/news.ts +188 -0
  545. package/src/resources/v1/instrument-data.ts +3 -0
  546. package/src/resources/v1/instruments.ts +611 -0
  547. package/src/resources/v1/omni-ai/entitlements.ts +170 -0
  548. package/src/resources/v1/omni-ai/index.ts +89 -0
  549. package/src/resources/v1/omni-ai/messages.ts +117 -0
  550. package/src/resources/v1/omni-ai/omni-ai.ts +527 -0
  551. package/src/resources/v1/omni-ai/responses.ts +220 -0
  552. package/src/resources/v1/omni-ai/threads.ts +460 -0
  553. package/src/resources/v1/omni-ai.ts +3 -0
  554. package/src/resources/v1/orders.ts +912 -0
  555. package/src/resources/v1/positions.ts +533 -0
  556. package/src/resources/v1/v1.ts +460 -0
  557. package/src/resources/v1/watchlist.ts +292 -0
  558. package/src/resources/v1/websocket.ts +26 -0
  559. package/src/resources/v1.ts +3 -0
  560. package/src/resources.ts +1 -0
  561. package/src/tsconfig.json +11 -0
  562. package/src/uploads.ts +2 -0
  563. package/src/version.ts +1 -0
  564. package/uploads.d.mts +3 -0
  565. package/uploads.d.mts.map +1 -0
  566. package/uploads.d.ts +3 -0
  567. package/uploads.d.ts.map +1 -0
  568. package/uploads.js +6 -0
  569. package/uploads.js.map +1 -0
  570. package/uploads.mjs +3 -0
  571. package/uploads.mjs.map +1 -0
  572. package/version.d.mts +2 -0
  573. package/version.d.mts.map +1 -0
  574. package/version.d.ts +2 -0
  575. package/version.d.ts.map +1 -0
  576. package/version.js +5 -0
  577. package/version.js.map +1 -0
  578. package/version.mjs +2 -0
  579. package/version.mjs.map +1 -0
@@ -0,0 +1,21 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../../../core/resource.mjs";
3
+ /**
4
+ * Retrieve instrument analytics, market data, news, and related reference data.
5
+ */
6
+ export class News extends APIResource {
7
+ /**
8
+ * Retrieves news items with optional filtering by security IDs, time range,
9
+ * publisher, type, and text query.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const response =
14
+ * await client.v1.instrumentData.news.getNews();
15
+ * ```
16
+ */
17
+ getNews(query = {}, options) {
18
+ return this._client.get('/v1/news', { query, ...options });
19
+ }
20
+ }
21
+ //# sourceMappingURL=news.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"news.mjs","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/news.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAKrD;;GAEG;AACH,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;OASG;IACH,OAAO,CACL,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF"}
@@ -0,0 +1,2 @@
1
+ export * from "./instrument-data/index.mjs";
2
+ //# sourceMappingURL=instrument-data.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"instrument-data.d.mts","sourceRoot":"","sources":["../../src/resources/v1/instrument-data.ts"],"names":[],"mappings":"AAEA,4CAAwC"}
@@ -0,0 +1,2 @@
1
+ export * from "./instrument-data/index.js";
2
+ //# sourceMappingURL=instrument-data.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"instrument-data.d.ts","sourceRoot":"","sources":["../../src/resources/v1/instrument-data.ts"],"names":[],"mappings":"AAEA,2CAAwC"}
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ const tslib_1 = require("../../internal/tslib.js");
5
+ tslib_1.__exportStar(require("./instrument-data/index.js"), exports);
6
+ //# sourceMappingURL=instrument-data.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"instrument-data.js","sourceRoot":"","sources":["../../src/resources/v1/instrument-data.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qEAAwC"}
@@ -0,0 +1,3 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ export * from "./instrument-data/index.mjs";
3
+ //# sourceMappingURL=instrument-data.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"instrument-data.mjs","sourceRoot":"","sources":["../../src/resources/v1/instrument-data.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,4CAAwC"}
@@ -0,0 +1,473 @@
1
+ import { APIResource } from "../../core/resource.mjs";
2
+ import * as Shared from "../shared.mjs";
3
+ import * as OrdersAPI from "./orders.mjs";
4
+ import * as V1API from "./v1.mjs";
5
+ import { APIPromise } from "../../core/api-promise.mjs";
6
+ import { RequestOptions } from "../../internal/request-options.mjs";
7
+ /**
8
+ * Retrieve core details and discovery endpoints for tradable instruments.
9
+ */
10
+ export declare class Instruments extends APIResource {
11
+ /**
12
+ * Retrieves detailed information for a specific instrument.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const response =
17
+ * await client.v1.instruments.getInstrumentByID(
18
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
19
+ * );
20
+ * ```
21
+ */
22
+ getInstrumentByID(instrumentID: OrdersAPI.InstrumentIDOrSymbol, query?: InstrumentGetInstrumentByIDParams | null | undefined, options?: RequestOptions): APIPromise<InstrumentGetInstrumentByIDResponse>;
23
+ /**
24
+ * Retrieves a list of tradeable instruments.
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * const response =
29
+ * await client.v1.instruments.getInstruments();
30
+ * ```
31
+ */
32
+ getInstruments(query?: InstrumentGetInstrumentsParams | null | undefined, options?: RequestOptions): APIPromise<InstrumentGetInstrumentsResponse>;
33
+ /**
34
+ * List options contracts.
35
+ *
36
+ * Returns options contracts for a given underlier with options-specific metadata.
37
+ * Exactly one underlier identifier must be provided.
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * const response =
42
+ * await client.v1.instruments.getOptionContracts();
43
+ * ```
44
+ */
45
+ getOptionContracts(query?: InstrumentGetOptionContractsParams | null | undefined, options?: RequestOptions): APIPromise<InstrumentGetOptionContractsResponse>;
46
+ /**
47
+ * Search instruments by symbol, alternate identifier, or company name.
48
+ *
49
+ * The `q` parameter is case-insensitive and supports ticker symbols, alternate
50
+ * identifiers such as CUSIP, ISIN, OPRA root, and CMS identifiers, and company
51
+ * names for non-option instruments. Results are ranked by match quality plus
52
+ * instrument quality signals including log-scaled ADV, listing status,
53
+ * marginability, easy-to-borrow status, and OTC, restricted, and liquidation-only
54
+ * penalties. Defaults to the `EQUITY` asset class (common stocks, preferred
55
+ * shares, ADRs, ETFs, and exchange-traded mutual funds). Pass `asset_class=OPTION`
56
+ * to search option contracts: by full OSI symbol, by an OSI prefix (root +
57
+ * `YYMMDD` expiry, e.g. `AAPL 261217`), or by a root-scoped phrase such as
58
+ * `AAPL Dec 250 call`.
59
+ *
60
+ * @example
61
+ * ```ts
62
+ * const response =
63
+ * await client.v1.instruments.searchInstruments({ q: 'q' });
64
+ * ```
65
+ */
66
+ searchInstruments(query: InstrumentSearchInstrumentsParams, options?: RequestOptions): APIPromise<InstrumentSearchInstrumentsResponse>;
67
+ }
68
+ /**
69
+ * The type of options contract
70
+ */
71
+ export type ContractType = 'CALL' | 'PUT';
72
+ /**
73
+ * The exercise style of an options contract
74
+ */
75
+ export type ExerciseStyle = 'AMERICAN' | 'EUROPEAN';
76
+ /**
77
+ * Represents a tradable financial instrument.
78
+ */
79
+ export interface Instrument {
80
+ /**
81
+ * Unique OEMS instrument identifier (UUID)
82
+ */
83
+ id: string;
84
+ /**
85
+ * The ISO country code of the instrument's issue
86
+ */
87
+ country_of_issue: string;
88
+ /**
89
+ * The ISO currency code in which the instrument is traded
90
+ */
91
+ currency: string;
92
+ /**
93
+ * Indicates if the instrument is classified as Easy-To-Borrow
94
+ */
95
+ easy_to_borrow: boolean;
96
+ /**
97
+ * Indicates if the instrument supports fractional-quantity orders
98
+ */
99
+ is_fractionable: boolean;
100
+ /**
101
+ * Indicates if the instrument is liquidation only and cannot be bought
102
+ */
103
+ is_liquidation_only: boolean;
104
+ /**
105
+ * Indicates if the instrument is marginable
106
+ */
107
+ is_marginable: boolean;
108
+ /**
109
+ * Indicates if the instrument is a publicly traded partnership (PTP). PTP sales
110
+ * are subject to a 10% withholding tax for non-US tax residents.
111
+ */
112
+ is_ptp: boolean;
113
+ /**
114
+ * Indicates if short selling is prohibited for the instrument
115
+ */
116
+ is_short_prohibited: boolean;
117
+ /**
118
+ * Indicates if the instrument is on the Regulation SHO Threshold Security List
119
+ */
120
+ is_threshold_security: boolean;
121
+ /**
122
+ * Indicates if the instrument is tradable
123
+ */
124
+ is_tradable: boolean;
125
+ /**
126
+ * The trading symbol for the instrument
127
+ */
128
+ symbol: string;
129
+ /**
130
+ * The MIC code of the primary listing venue
131
+ */
132
+ venue: string;
133
+ /**
134
+ * Average daily share volume from the security definition.
135
+ */
136
+ adv?: string | null;
137
+ /**
138
+ * The expiration date for options instruments
139
+ */
140
+ expiry?: string | null;
141
+ /**
142
+ * The type of security (e.g., Common Stock, ETF)
143
+ */
144
+ instrument_type?: V1API.SecurityType | null;
145
+ /**
146
+ * The percent of a long position's value you must post as margin
147
+ */
148
+ long_margin_rate?: string | null;
149
+ /**
150
+ * The full name of the instrument or its issuer
151
+ */
152
+ name?: string | null;
153
+ /**
154
+ * Notional ADV (`adv × previous_close`). The primary liquidity signal used by
155
+ * `/instruments/search` ranking. Computed at response time so it stays consistent
156
+ * with whatever `adv` and `previous_close` show.
157
+ */
158
+ notional_adv?: string | null;
159
+ /**
160
+ * Available options expiration dates for this instrument. Present only when
161
+ * `include_options_expiry_dates=true` in the request.
162
+ */
163
+ options_expiry_dates?: Array<string> | null;
164
+ /**
165
+ * Last close price from the security definition.
166
+ */
167
+ previous_close?: string | null;
168
+ /**
169
+ * The percent of a short position's value you must post as margin
170
+ */
171
+ short_margin_rate?: string | null;
172
+ /**
173
+ * The strike price for options instruments
174
+ */
175
+ strike_price?: string | null;
176
+ }
177
+ export interface InstrumentCore {
178
+ /**
179
+ * Unique OEMS instrument identifier (UUID)
180
+ */
181
+ id: string;
182
+ /**
183
+ * The ISO country code of the instrument's issue
184
+ */
185
+ country_of_issue: string;
186
+ /**
187
+ * The ISO currency code in which the instrument is traded
188
+ */
189
+ currency: string;
190
+ /**
191
+ * Indicates if the instrument is classified as Easy-To-Borrow
192
+ */
193
+ easy_to_borrow: boolean;
194
+ /**
195
+ * Indicates if the instrument supports fractional-quantity orders
196
+ */
197
+ is_fractionable: boolean;
198
+ /**
199
+ * Indicates if the instrument is liquidation only and cannot be bought
200
+ */
201
+ is_liquidation_only: boolean;
202
+ /**
203
+ * Indicates if the instrument is marginable
204
+ */
205
+ is_marginable: boolean;
206
+ /**
207
+ * Indicates if the instrument is a publicly traded partnership (PTP). PTP sales
208
+ * are subject to a 10% withholding tax for non-US tax residents.
209
+ */
210
+ is_ptp: boolean;
211
+ /**
212
+ * Indicates if short selling is prohibited for the instrument
213
+ */
214
+ is_short_prohibited: boolean;
215
+ /**
216
+ * Indicates if the instrument is on the Regulation SHO Threshold Security List
217
+ */
218
+ is_threshold_security: boolean;
219
+ /**
220
+ * Indicates if the instrument is tradable
221
+ */
222
+ is_tradable: boolean;
223
+ /**
224
+ * The trading symbol for the instrument
225
+ */
226
+ symbol: string;
227
+ /**
228
+ * The MIC code of the primary listing venue
229
+ */
230
+ venue: string;
231
+ /**
232
+ * Average daily share volume from the security definition.
233
+ */
234
+ adv?: string | null;
235
+ /**
236
+ * The expiration date for options instruments
237
+ */
238
+ expiry?: string | null;
239
+ /**
240
+ * The type of security (e.g., Common Stock, ETF)
241
+ */
242
+ instrument_type?: V1API.SecurityType | null;
243
+ /**
244
+ * The percent of a long position's value you must post as margin
245
+ */
246
+ long_margin_rate?: string | null;
247
+ /**
248
+ * The full name of the instrument or its issuer
249
+ */
250
+ name?: string | null;
251
+ /**
252
+ * Notional ADV (`adv × previous_close`). The primary liquidity signal used by
253
+ * `/instruments/search` ranking. Computed at response time so it stays consistent
254
+ * with whatever `adv` and `previous_close` show.
255
+ */
256
+ notional_adv?: string | null;
257
+ /**
258
+ * Last close price from the security definition.
259
+ */
260
+ previous_close?: string | null;
261
+ /**
262
+ * The percent of a short position's value you must post as margin
263
+ */
264
+ short_margin_rate?: string | null;
265
+ /**
266
+ * The strike price for options instruments
267
+ */
268
+ strike_price?: string | null;
269
+ }
270
+ export type InstrumentCoreList = Array<InstrumentCore>;
271
+ /**
272
+ * The listing type of an options contract
273
+ */
274
+ export type ListingType = 'STANDARD' | 'FLEX' | 'OTC';
275
+ /**
276
+ * An options contract with options-specific metadata
277
+ */
278
+ export interface OptionsContract {
279
+ /**
280
+ * OEMS instrument identifier
281
+ */
282
+ id: string;
283
+ /**
284
+ * Whether this is a CALL or PUT
285
+ */
286
+ contract_type: ContractType;
287
+ /**
288
+ * ISO currency code
289
+ */
290
+ currency: string;
291
+ /**
292
+ * MIC code of the primary listing venue
293
+ */
294
+ exchange: string;
295
+ /**
296
+ * Exercise style
297
+ */
298
+ exercise_style: ExerciseStyle;
299
+ /**
300
+ * Expiration date
301
+ */
302
+ expiry: string;
303
+ /**
304
+ * Whether the contract is liquidation-only
305
+ */
306
+ is_liquidation_only: boolean;
307
+ /**
308
+ * Whether the contract is marginable
309
+ */
310
+ is_marginable: boolean;
311
+ /**
312
+ * Listing type
313
+ */
314
+ listing_type: ListingType;
315
+ /**
316
+ * Contract multiplier (100 for standard options)
317
+ */
318
+ multiplier: string;
319
+ /**
320
+ * Strike price
321
+ */
322
+ strike_price: string;
323
+ /**
324
+ * OSI symbol (e.g. "AAPL 251219C00150000")
325
+ */
326
+ symbol: string;
327
+ /**
328
+ * Open interest (number of outstanding contracts), if available
329
+ */
330
+ open_interest?: number | null;
331
+ /**
332
+ * OEMS instrument ID of the underlying instrument, if resolvable
333
+ */
334
+ underlying_instrument_id?: string | null;
335
+ }
336
+ export type OptionsContractList = Array<OptionsContract>;
337
+ export interface InstrumentGetInstrumentByIDResponse extends Shared.BaseResponse {
338
+ /**
339
+ * Represents a tradable financial instrument.
340
+ */
341
+ data: Instrument;
342
+ }
343
+ export interface InstrumentGetInstrumentsResponse extends Shared.BaseResponse {
344
+ data: InstrumentCoreList;
345
+ }
346
+ export interface InstrumentGetOptionContractsResponse extends Shared.BaseResponse {
347
+ data: OptionsContractList;
348
+ }
349
+ export interface InstrumentSearchInstrumentsResponse extends Shared.BaseResponse {
350
+ data: InstrumentCoreList;
351
+ }
352
+ export interface InstrumentGetInstrumentByIDParams {
353
+ /**
354
+ * When true, include unique options expiry dates for this instrument
355
+ */
356
+ include_options_expiry_dates?: boolean | null;
357
+ }
358
+ export interface InstrumentGetInstrumentsParams {
359
+ /**
360
+ * Filter by easy to borrow status
361
+ */
362
+ easy_to_borrow?: boolean;
363
+ /**
364
+ * Comma-separated OEMS instrument UUIDs
365
+ */
366
+ instrument_ids?: Array<string>;
367
+ /**
368
+ * Filter by instrument type (e.g. COMMON_STOCK, OPTION)
369
+ */
370
+ instrument_type?: 'COMMON_STOCK' | 'OPTION' | 'CASH';
371
+ /**
372
+ * Filter by liquidation only status
373
+ */
374
+ is_liquidation_only?: boolean;
375
+ /**
376
+ * Filter by marginable status
377
+ */
378
+ is_marginable?: boolean;
379
+ /**
380
+ * Filter by publicly traded partnership (PTP) status
381
+ */
382
+ is_ptp?: boolean;
383
+ /**
384
+ * Filter by short prohibited status
385
+ */
386
+ is_short_prohibited?: boolean;
387
+ /**
388
+ * Filter by threshold security status
389
+ */
390
+ is_threshold_security?: boolean;
391
+ /**
392
+ * The number of items to return per page. Only used when page_token is not
393
+ * provided.
394
+ */
395
+ page_size?: number;
396
+ /**
397
+ * Token for retrieving the next or previous page of results. Contains encoded
398
+ * pagination state; when provided, page_size is ignored.
399
+ */
400
+ page_token?: string;
401
+ }
402
+ export interface InstrumentGetOptionContractsParams {
403
+ /**
404
+ * Filter by contract type: CALL or PUT
405
+ */
406
+ contract_type?: ContractType;
407
+ /**
408
+ * Filter to contracts expiring on this date (YYYY-MM-DD)
409
+ */
410
+ expiry?: string;
411
+ /**
412
+ * The number of items to return per page. Only used when page_token is not
413
+ * provided.
414
+ */
415
+ page_size?: number;
416
+ /**
417
+ * Token for retrieving the next or previous page of results. Contains encoded
418
+ * pagination state; when provided, page_size is ignored.
419
+ */
420
+ page_token?: string;
421
+ /**
422
+ * Underlier symbol (e.g., AAPL, SPX)
423
+ */
424
+ underlier?: string;
425
+ /**
426
+ * OEMS instrument UUID or symbol of the underlying equity/index
427
+ */
428
+ underlying_instrument_id?: OrdersAPI.InstrumentIDOrSymbol;
429
+ }
430
+ export interface InstrumentSearchInstrumentsParams {
431
+ /**
432
+ * Search term applied case-insensitively to ticker symbols, alternate identifiers
433
+ * (CUSIP, ISIN, OPRA root, CMS), and company names for non-option instruments.
434
+ * Option searches match symbols and alternate identifiers.
435
+ */
436
+ q: string;
437
+ /**
438
+ * Comma-separated asset classes (EQUITY|OPTION|WARRANT|BOND|FX|OTHER). Defaults to
439
+ * EQUITY.
440
+ */
441
+ asset_class?: string;
442
+ /**
443
+ * Optional listing-country filter (e.g., US).
444
+ */
445
+ country?: string;
446
+ /**
447
+ * Optional ISO currency filter (e.g., USD).
448
+ */
449
+ currency?: string;
450
+ /**
451
+ * Include inactive instruments. Default false.
452
+ */
453
+ include_inactive?: boolean;
454
+ /**
455
+ * Include publicly traded partnership (PTP) instruments. Default true (penalized
456
+ * in ranking).
457
+ */
458
+ include_ptp?: boolean;
459
+ /**
460
+ * The number of items to return per page. Only used when page_token is not
461
+ * provided.
462
+ */
463
+ page_size?: number;
464
+ /**
465
+ * Token for retrieving the next or previous page of results. Contains encoded
466
+ * pagination state; when provided, page_size is ignored.
467
+ */
468
+ page_token?: string;
469
+ }
470
+ export declare namespace Instruments {
471
+ export { type ContractType as ContractType, type ExerciseStyle as ExerciseStyle, type Instrument as Instrument, type InstrumentCore as InstrumentCore, type InstrumentCoreList as InstrumentCoreList, type ListingType as ListingType, type OptionsContract as OptionsContract, type OptionsContractList as OptionsContractList, type InstrumentGetInstrumentByIDResponse as InstrumentGetInstrumentByIDResponse, type InstrumentGetInstrumentsResponse as InstrumentGetInstrumentsResponse, type InstrumentGetOptionContractsResponse as InstrumentGetOptionContractsResponse, type InstrumentSearchInstrumentsResponse as InstrumentSearchInstrumentsResponse, type InstrumentGetInstrumentByIDParams as InstrumentGetInstrumentByIDParams, type InstrumentGetInstrumentsParams as InstrumentGetInstrumentsParams, type InstrumentGetOptionContractsParams as InstrumentGetOptionContractsParams, type InstrumentSearchInstrumentsParams as InstrumentSearchInstrumentsParams, };
472
+ }
473
+ //# sourceMappingURL=instruments.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"instruments.d.mts","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,KAAK,KAAK,iBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;OAQG;IACH,cAAc,CACZ,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,iBAAiB,CACf,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAGnD;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,KAAK,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,UAAU,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,MAAM,GAAG,KAAK,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;AAEzD,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,GAAG,QAAQ,GAAG,MAAM,CAAC;IAErD;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,wBAAwB,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAC3D;AAED,MAAM,WAAW,iCAAiC;IAChD;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}