alpacahq / bkdocs Goto Github PK
View Code? Open in Web Editor NEWBroker API Documentation
Broker API Documentation
When using the OpenAPI yaml, a nullable field is expected to not exist if it is null. If instead it is "fieldName": null
, the generated code (for example, in Go) will treat it like this: {"value": null, "exists:" true}
, which is an odd and unexpected outcome.
This should be boolean
We are generating code to produce and parse messages from SSE, but it seems like Trade Events are missing:
https://alpaca.markets/docs/broker/api-references/events/#trade-updates
On this page https://alpaca.markets/docs/broker/integration/ there is a link for Going Live which points to https://alpaca.markets/docs/integration/#going-live and it currently 404s
In this file https://github.com/alpacahq/bkdocs/blob/master/content/integration/_index.md
To go live, we will onboard you for the business integration. For more details
of this step, please refer to [Going Live](/docs/integration/#going-live)
When calling GET /v1/calendar
it's not behave as explained in documentation:
Calendar
objects is returned instead of "The calendar object" as written in documentationCalendar
objects. Expected and more logical behavior would be to return the Calendar
object with empty open
and close
fields or add explicit checkbox is_market_open
. It will be nice if the fact that API skip days would be added to documentation.start=2021-01-08 end=2021-01-09
the result will contain only one record which will be the next day when markets will be open. This behavior is not explained at all, it's unclear if it's intended or not.Line 1867 in fdbeb0f
Was this intentional? When using the openapi generator in go, this turns into a struct field without a name (immediate syntax error)
Looks like AccountStatusEvent doesn't have an event id:
https://github.com/alpacahq/bkdocs/blob/master/assets/openapi.yaml#L1818-L1838
Whereas the docs indicate it should:
https://alpaca.markets/docs/broker/api-references/events/#response
The AccountStatus.EDITED
status described in the docs is missing from the spec at https://github.com/alpacahq/bkdocs/blob/master/assets/openapi.yaml#L154.
I believe this endpoint is missing from the yaml:
https://alpaca.markets/docs/broker/api-references/trading/portfolio-history/
Endpoint: POST /v1/accounts/{account_id}/documents/upload
Issue:
The endpoint accepts an array of models.DocumentUpload, and this document_upload
needs to be removed from the doc.
Reference:
But the parameter list says it's string
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.