-
Notifications
You must be signed in to change notification settings - Fork 72
[DVX-1134] Updated with latest 2025-11-19 spec #249
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
penelopus
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@justinpolygon — since there are some renamed objects in this PR (namely, websocket interfaces), this seems to be a breaking change and would require a bump to v10, rather than a minor version update to v9.1
also a couple of other comments herein
| // Skip paths starting with /v1/reference/ | ||
| if (path.startsWith('/v1/reference/')) continue; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| // Skip paths starting with /v1/reference/ | |
| if (path.startsWith('/v1/reference/')) continue; |
@justinpolygon — why is this exclusion necessary?
in today's api, there are 4 endpoints w/ this pattern (/v1/reference/sec/filings...), and each currently include the x-polygon-draft flag (which is captured by the preceding rule)
what happens when the x-polygon-draft flag is removed from those v1 endpoints?
i recommend removing this exception
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @penelopus, in the spec https://api.polygon.io/openapi there are a handful of internal endpoints for sec filings etc hanging off /v1/reference. So, It was just to exclude those from the library. No one has access to them so doesn't make sense to generate functions/examples since no one can use them.
I'll test it. Maybe we don't need both. I'll check back shortly.
| "stock api", | ||
| "options api", | ||
| "forex api", | ||
| "crypto api" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this should also include "futures api" to reflect recent updates
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll get that added. Good catch.
Description
Sync with latest 2025-11-19 openapi spec. Also scrubbed references of Polygon. There are many line changes here since when you update the spec is moves lots of stuff around. So, most of these are not even changes.
Related Issue
https://linear.app/massive-com/issue/DVX-1134/republish-client-js-library
How Has This Been Tested?
Built the package and tested with Docker.