# README
Go API client for openfigi
A free & open API for FIGI discovery.
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 1.3.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://openfigi.com/api
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
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/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | MappingPost | Post /mapping | |
| DefaultApi | MappingValuesKeyGet | Get /mapping/values/{key} |
Documentation For Models
- FigiResult
- InlineResponse200
- MappingJob
- MappingJobResult
- MappingJobResultFigiList
- MappingJobResultFigiNotFound
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
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
# Structs
APIClient manages communication with the OpenFIGI API API v1.3.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
FigiResult struct for FigiResult.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
InlineResponse200 struct for InlineResponse200.
MappingJob For V2: securityType2 is required when idType is BASE_TICKER or ID_EXCH_SYMBOL.
MappingJobResult struct for MappingJobResult.
MappingJobResultFigiList struct for MappingJobResultFigiList.
MappingJobResultFigiNotFound struct for MappingJobResultFigiNotFound.
MappingPostOpts Optional parameters for the method 'MappingPost'.
# Type aliases
DefaultApiService DefaultApi service.