Skip to content

Latest commit

 

History

History
56 lines (31 loc) · 2.26 KB

getting-started.md

File metadata and controls

56 lines (31 loc) · 2.26 KB
title has_children nav_order
Getting Started
false
1

Getting Started

The simplest way to start consuming forecasts is with grpcurl. Install this, and then continue below.

Creating an account

Visit https://anko-investor.com/ and click "Get Started".

This will take you to Auth0, where you may either login or signup. If you have a current Auth0 session you may even be automatically signed in.

From here you will be redirected to the Dashboard.

Dashboard

The Dashboard contains three pieces of information. Your Organisation membership, News and Updates from the Anko Investor team, and a set of events and notifications for audit.

For now we will concentrate on Organisations.

Click the + button next to My Organisations and fill out the Create Organisation form. The billing email may be used to provide account icons via Gravatar.

On creation of a new Organisation, a link will appear on the page to the Organisation Page

Organisation page

The Organisation Page is used to invite members, update your organisation, and view organisation specific events.

For now we will use the other feature; creating Tokens.

Anko Investor uses token-based authentication to ensure you get access to the Forecasts you're entitled to, and are expecting.

Click the + next to Tokens and fill out the form. Minimum Score is described here.

On Creation, your token will appear. This is the last time your token will appear, so make a note of it!

Streaming Forecasts

Given the token anko-abc123, the following command will stream forecasts.

$ grpcurl -H 'authorization: bearer anko-abc123' forecasts.anko-investor.com:443 Forecasts/Stream

The first forecast you will receive is a dummy forecast which signifies that the connection has been created correctly.

The gRPC service at forecasts.anko-investor.com:443 supports reflection and, so, exploring the response format is reasonably simple.

Otherwise, the .proto file which this service is generated at can be found here.

This file can also be used to generate client code.