Giter VIP home page Giter VIP logo

alpaca-docs's Introduction

alpaca-docs

Developer documentation for Alpaca API's.

Requirements

Build

To build the site, run hugo in the root directory. You should have the built site in public directory.

Live preview

Run hugo serve and it should spin up a local server with the site.

Contributing

If you find a discrepancy with documentation, a typo or simply some new section to add or improve you can clone the docs and add contribute.

  1. Clone repo git clone https://github.com/alpacahq/alpaca-docs.git

  2. Make changes and preview with hugo serve. Hugo has autoreload capabilities so as you change you should see things get refreshed.

alpaca-docs's People

Contributors

aleksandrkovshariov avatar andrewwoood avatar brimagnin avatar c-ottaway avatar cruales avatar danielbancsi avatar dependabot[bot] avatar drew887 avatar e-shiels avatar excavator20 avatar grdsdev avatar gsmadi avatar haxdds avatar julian-esteban avatar kavinamaren avatar mahmoudksherif avatar malpaca7 avatar mszaro avatar nil425 avatar peterferguson avatar raciborski avatar raja avatar razakhan01 avatar rpescador avatar sfhemstreet avatar sfritz avatar tamirhfrank avatar umitanuki avatar whitnable avatar zayeemas avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

alpaca-docs's Issues

Market Data Bars are missing `n` and `vw`

This one has been reported in a few places now, but opening this one for public visibility into tracking it as well.

Market data docs are missing references to the Bar models' n and vw fields.

AccountStatus does not have `INACTIVE` value when opening a new account

Expected one of [ONBOARDING, SUBMITTED, RESUBMITTED, SUBMISSION_FAILED, ACTION_REQUIRED, EDITED, ACCOUNT_UPDATED, APPROVAL_PENDING, REAPPROVAL_PENDING, SIGNED_UP, KYC_SUBMITTED, LIMITED, AML_REVIEW, APPROVED, REJECTED, ACTIVE, DISABLED, DISABLE_PENDING, ACCOUNT_CLOSED, PAPER_ONLY
] but was INACTIVE at path $.crypto_status

Adding INACTIVE to the yaml file fixes the issue.

JNLC `correct` status

In Broker API /v1/journals/{journalId} returns "status": "correct" for some journals.

How is it different from executed status?
No documentation on this

Could the data points key name not contain same letter across different Schemas

Could the data points key letter "c" not contain different values

Under Trade Schema:

c =  trade condition

Under Quote Schema:

c = quote condition

Under Minute Bar Schema:

c = close price

I feel it would be ideal to not reuse these same key names for different values.
Saves me needing to do an if statement on the T key :)

Reference: https://alpaca.markets/docs/api-references/market-data-api/stock-pricing-data/realtime/#data-points

TradeUpdateEvent has TransferEvent content

title: TradeUpdateEvent
properties:
account_id:
type: string
minLength: 1
description: Account UUID
format: uuid
at:
type: string
minLength: 1
description: Timedate of when the transfer status changed
format: date-time
event_id:
type: integer
description: Monotonically increasing 64bit integer
status_from:
$ref: '#/components/schemas/TransferStatus'
status_to:
$ref: '#/components/schemas/TransferStatus'
transfer_id:
type: string
minLength: 1
description: Transfer UUID
format: uuid
required:
- account_id
- at
- event_id
- status_from
- status_to
- transfer_id

It looks like TradeUpdateEvent has the TransferEvent content

Endpoint not found

Following the doc on this page, v2 endpoint returns an error:

{ "message": "endpoint not found." }

But using v1, things seem ok. An update to the docs is needed

Crypto latest quote api says exchange is csv query parameter but only accepts 1 value

When I try to pass a csv to this endpoint I got a 422. I think the docs here are wrong?

desc: The comma-separated exchanges which can be FTXU, ERSX or CBSE. Defaults to All.

HTTP/1.1 422 Unprocessable Entity returned for "https://data.alpaca.markets/v1beta1/crypto/BTCUSD/quotes/latest?exchange=FTXU,ERSX,CBSE".
[
  "code" => 42210000
  "message" => "invalid exchange: FTXU,ERSX,CBSE"
]

Missing NTA Events

/v1/events/trades:

is missing NTA events:

https://alpaca.markets/docs/api-references/broker-api/events/#non-trading-activities-events

One of the things I noticed is that the data is not in the same format as a NonTradeActivity here:

https://alpaca.markets/docs/api-references/broker-api/accounts/account-activities/#the-non-trade-activity-nta-object

For example, activity_type in NTA is entry_type in NTA events. net_amount also switches between num and string.

DocumentAPI Build Error

Generated the code with below command and get build error

npx openapi-generator-cli generate -i broker/openapi.yaml -g csharp-netcore -o build/csharp-netcore --additional-properties aspnetCoreVersion=3.1

Severity Code Description Project File Line Suppression State
Error CS0246 The type or namespace name 'Set' could not be found (are you missing a using directive or an assembly reference?) Org.OpenAPITools C:\alpaca-docs\oas\build\csharp-netcore\src\Org.OpenAPITools\Api\DocumentsApi.cs 86 Active

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.