openfigi

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 27, 2023 License: MIT Imports: 21 Imported by: 0

README

Go API client for openfigi

A free & open API for FIGI discovery.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 1.4.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://openfigi.com/api

Installation

Put the package under your project folder and add the following in import:

import "./openfigi"

Documentation for API Endpoints

All URIs are relative to https://api.openfigi.com/{basePath}

Class Method HTTP request Description
DefaultApi MappingPost Post /mapping
DefaultApi MappingValuesKeyGet Get /mapping/values/{key}

Documentation For Models

Documentation For Authorization

ApiKeyAuth

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

support@openfigi.com

Documentation

Overview

* OpenFIGI API * * A free & open API for FIGI discovery. * * API version: 1.4.0 * Contact: support@openfigi.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* OpenFIGI API * * A free & open API for FIGI discovery. * * API version: 1.4.0 * Contact: support@openfigi.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* OpenFIGI API * * A free & open API for FIGI discovery. * * API version: 1.4.0 * Contact: support@openfigi.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* OpenFIGI API * * A free & open API for FIGI discovery. * * API version: 1.4.0 * Contact: support@openfigi.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* OpenFIGI API * * A free & open API for FIGI discovery. * * API version: 1.4.0 * Contact: support@openfigi.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* OpenFIGI API * * A free & open API for FIGI discovery. * * API version: 1.4.0 * Contact: support@openfigi.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* OpenFIGI API * * A free & open API for FIGI discovery. * * API version: 1.4.0 * Contact: support@openfigi.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* OpenFIGI API * * A free & open API for FIGI discovery. * * API version: 1.4.0 * Contact: support@openfigi.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* OpenFIGI API * * A free & open API for FIGI discovery. * * API version: 1.4.0 * Contact: support@openfigi.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* OpenFIGI API * * A free & open API for FIGI discovery. * * API version: 1.4.0 * Contact: support@openfigi.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	DefaultApi *DefaultApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the OpenFIGI API API v1.4.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type DefaultApiMappingPostOpts 

type DefaultApiMappingPostOpts struct {
	Body optional.Interface
}

type DefaultApiService 

type DefaultApiService service

func (*DefaultApiService) FilterPost added in v1.2.0 

func (a *DefaultApiService) FilterPost(ctx context.Context, job FilterJob) (FilterJobResult, *http.Response, error)

func (*DefaultApiService) MappingPost 

func (a *DefaultApiService) MappingPost(ctx context.Context, localVarOptionals *DefaultApiMappingPostOpts) ([]MappingJobResult, *http.Response, error)

func (*DefaultApiService) MappingValuesKeyGet 

func (a *DefaultApiService) MappingValuesKeyGet(ctx context.Context, key string) (InlineResponse200, *http.Response, error)

DefaultApiService Get values for enum-like fields.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key Key of MappingJob for which to get possible values.

@return InlineResponse200

func (*DefaultApiService) SearchPost added in v1.1.0 

func (a *DefaultApiService) SearchPost(ctx context.Context, job SearchJob) (SearchJobResult, *http.Response, error)

type FigiResult 

type FigiResult struct {
	Figi                string `json:"figi,omitempty"`
	SecurityType        string `json:"securityType,omitempty"`
	MarketSector        string `json:"marketSector,omitempty"`
	Ticker              string `json:"ticker,omitempty"`
	Name                string `json:"name,omitempty"`
	ExchCode            string `json:"exchCode,omitempty"`
	ShareClassFIGI      string `json:"shareClassFIGI,omitempty"`
	CompositeFIGI       string `json:"compositeFIGI,omitempty"`
	SecurityType2       string `json:"securityType2,omitempty"`
	SecurityDescription string `json:"securityDescription,omitempty"`
	// Exists when API is unable to show non-FIGI fields.
	Metadata string `json:"metadata,omitempty"`
}

type FilterJob added in v1.2.0 

type FilterJob struct {
	Query                   string     `json:"query"`
	Start                   string     `json:"start,omitempty"`
	ExchCode                string     `json:"exchCode,omitempty"`
	MicCode                 string     `json:"micCode,omitempty"`
	Currency                string     `json:"currency,omitempty"`
	MarketSecDes            string     `json:"marketSecDes,omitempty"`
	SecurityType            string     `json:"securityType,omitempty"`
	SecurityType2           string     `json:"securityType2,omitempty"`
	IncludeUnlistedEquities bool       `json:"includeUnlistedEquities,omitempty"`
	OptionType              string     `json:"optionType,omitempty"`
	Strike                  *[]float64 `json:"strike,omitempty"`
	ContractSize            *[]float64 `json:"contractSize,omitempty"`
	Coupon                  *[]float64 `json:"coupon,omitempty"`
	Expiration              *[]string  `json:"expiration,omitempty"`
	Maturity                *[]string  `json:"maturity,omitempty"`
	StateCode               string     `json:"stateCode,omitempty"`
}

type FilterJobResult added in v1.2.0 

type FilterJobResult struct {
	Data  []FigiResult `json:"data"`
	Error string       `json:"error,omitempty"`
	Next  string       `json:"next,omitempty"`
	Total int          `json:"total,omitempty"`
}

type GenericSwaggerError 

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type InlineResponse200 

type InlineResponse200 struct {
	Values []string `json:"values,omitempty"`
}

type MappingJob 

type MappingJob[IdValueType comparable] struct {
	IdType                  string      `json:"idType"`
	IdValue                 IdValueType `json:"idValue"`
	ExchCode                string      `json:"exchCode,omitempty"`
	MicCode                 string      `json:"micCode,omitempty"`
	Currency                string      `json:"currency,omitempty"`
	MarketSecDes            string      `json:"marketSecDes,omitempty"`
	SecurityType            string      `json:"securityType,omitempty"`
	SecurityType2           string      `json:"securityType2,omitempty"`
	IncludeUnlistedEquities bool        `json:"includeUnlistedEquities,omitempty"`
	OptionType              string      `json:"optionType,omitempty"`
	Strike                  *[]float64  `json:"strike,omitempty"`
	ContractSize            *[]float64  `json:"contractSize,omitempty"`
	Coupon                  *[]float64  `json:"coupon,omitempty"`
	Expiration              *[]string   `json:"expiration,omitempty"`
	Maturity                *[]string   `json:"maturity,omitempty"`
	StateCode               string      `json:"stateCode,omitempty"`
}

For V3: securityType2 is required when idType is BASE_TICKER or ID_EXCH_SYMBOL. expiration is required when securityType2 is Option or Warrant. maturity is required when securityType2 is Pool.

type MappingJobResult 

type MappingJobResult struct {
	MappingJobResultFigiList
	MappingJobResultFigiNotFound
}

type MappingJobResultFigiList 

type MappingJobResultFigiList struct {
	Data []FigiResult `json:"data,omitempty"`
}

type MappingJobResultFigiNotFound 

type MappingJobResultFigiNotFound struct {
	Warning string `json:"warning,omitempty"`
}

type SearchJob added in v1.1.0 

type SearchJob struct {
	Query                   string     `json:"query"`
	Start                   string     `json:"start"`
	ExchCode                string     `json:"exchCode,omitempty"`
	MicCode                 string     `json:"micCode,omitempty"`
	Currency                string     `json:"currency,omitempty"`
	MarketSecDes            string     `json:"marketSecDes,omitempty"`
	SecurityType            string     `json:"securityType,omitempty"`
	SecurityType2           string     `json:"securityType2,omitempty"`
	IncludeUnlistedEquities bool       `json:"includeUnlistedEquities,omitempty"`
	OptionType              string     `json:"optionType,omitempty"`
	Strike                  *[]float64 `json:"strike,omitempty"`
	ContractSize            *[]float64 `json:"contractSize,omitempty"`
	Coupon                  *[]float64 `json:"coupon,omitempty"`
	Expiration              *[]string  `json:"expiration,omitempty"`
	Maturity                *[]string  `json:"maturity,omitempty"`
	StateCode               string     `json:"stateCode,omitempty"`
}

type SearchJobResult added in v1.1.0 

type SearchJobResult struct {
	Data  []FigiResult `json:"data"`
	Error string       `json:"error,omitempty"`
	Next  string       `json:"next,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.