yfin

Documentation

Index

• func CreateCrumb(crumb []interface{}) (int, interface{})
• type ChartResponse
  • func CreateChart(chart interface{}) (int, *ChartResponse)
• type CrumbResponse
• type Error
• type ErrorResponse
  • func CreateInternalServerError() (int, *ErrorResponse)
  • func CreateMissingSymbolsError() (int, *ErrorResponse)
• type OptionsResponse
  • func CreateOptions(options interface{}) (int, *OptionsResponse)
• type QuoteResponse
  • func CreateQuote(quotes []interface{}) (int, *QuoteResponse)
• type Response

Functions

func CreateCrumb

func CreateCrumb(crumb []interface{}) (int, interface{})

CreateCrumb creates a valid crumb response.

Types

type ChartResponse

type ChartResponse struct {
	*Response `json:"chart"`
}

ChartResponse contains a chart response msg.

func CreateChart

func CreateChart(chart interface{}) (int, *ChartResponse)

CreateChart creates a valid chart response.

type CrumbResponse

type CrumbResponse string

CrumbResponse contains a crumb response msg.

type Error

type Error struct {
	Info        string `json:"code"`
	Description string `json:"description"`
}

Error internal error information structure.

type ErrorResponse

type ErrorResponse struct {
	*Response `json:"error"`
}

ErrorResponse contains a response error msg.

func CreateInternalServerError

func CreateInternalServerError() (int, *ErrorResponse)

CreateInternalServerError creates an internal server error for API issues.

func CreateMissingSymbolsError

func CreateMissingSymbolsError() (int, *ErrorResponse)

CreateMissingSymbolsError creates an missing argument error for API issues.

type OptionsResponse

type OptionsResponse struct {
	*Response `json:"optionChain"`
}

OptionsResponse contains a options response msg.

func CreateOptions

func CreateOptions(options interface{}) (int, *OptionsResponse)

CreateOptions creates a valid options response.

type QuoteResponse

type QuoteResponse struct {
	*Response `json:"quoteResponse"`
}

QuoteResponse contains a quote response msg.

func CreateQuote

func CreateQuote(quotes []interface{}) (int, *QuoteResponse)

CreateQuote creates a valid quote response.

type Response

type Response struct {
	Result interface{} `json:"result"`
	Error  *Error      `json:"error"`
}

Response contains a response msg.