Go API client for forms13f

API for SEC form filings such as 13F.

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.0.0
Package version: 1.0.0
Generator version: 7.11.0
Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

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

import forms13f "github.com/forms13f/go-sdk"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value forms13f.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), forms13f.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value forms13f.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), forms13f.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using forms13f.ContextOperationServerIndices and forms13f.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), forms13f.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), forms13f.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://forms13f.com

Class	Method	HTTP request	Description
DefaultAPI	ApiV1FilerGet	Get /api/v1/filer	Retrieve a filer by CIK.
DefaultAPI	ApiV1FilersGet	Get /api/v1/filers	Retrieve unique filers.
DefaultAPI	ApiV1FilingsGet	Get /api/v1/filings	Retrieve 13F filings for all filers in the time range.
DefaultAPI	ApiV1FormGet	Get /api/v1/form	Get SEC Form 13F.
DefaultAPI	ApiV1FormsGet	Get /api/v1/forms	Retrieve SEC forms 13F for a filer.
DefaultAPI	ApiV1FundsGet	Get /api/v1/funds	Retrieve unique companies.
DefaultAPI	ApiV1TickersGet	Get /api/v1/tickers	Returns cusip, ticker, and company name for provided matching cusips or tickers parameters

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

Author

[email protected]

# Packages

# README