iv_models

package
v1.1.1 Latest Latest
Warning

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

Go to latest
Published: Oct 4, 2022 License: MIT Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConversionOrExercisePrice

type ConversionOrExercisePrice struct {
	XMLName xml.Name `xml:"conversionOrExercisePrice"`
	Value   float32  `xml:"value"`
}

type DB_BaseForm4

type DB_BaseForm4 struct {
	Parsed                    bool                          `json:"parsed" bson:"parsed"`
	PeriodOfReport            string                        `json:"periodOfReport" bson:"periodOfReport"`
	AccessionNumber           string                        `json:"accessionNumber" bson:"accessionNumber"`
	Url                       string                        `json:"url" bson:"url"`
	DateAdded                 string                        `json:"dateAdded" bson:"dateAdded"`
	Issuer                    DB_Issuer                     `json:"issuer" bson:"issuer"`
	Reporters                 []DB_Reporter                 `json:"reporters" bson:"reporters"`
	DerivativeTransactions    []DB_DerivativeTransaction    `json:"derivativeTransactions" bson:"derivativeTransactions"`
	NonDerivativeTransactions []DB_NonDerivativeTransaction `json:"nonDerivativeTransactions" bson:"nonDerivativeTransactions"`
}

type DB_DeltaForm

type DB_DeltaForm struct {
	AccessionNumber       string        `json:"accessionNumber" bson:"accessionNumber"`
	FormClass             string        `json:"formClass" bson:"formClass"`
	PeriodOfReport        string        `json:"periodOfReport" bson:"periodOfReport"`
	AveragePricePerShare  float32       `json:"averagePricePerShare" bson:"averagePricePerShare"`
	NetTotal              float32       `json:"netTotal" bson:"netTotal"`
	SharesTraded          float32       `json:"sharesTraded" bson:"sharesTraded"`
	PostTransactionShares float32       `json:"postTransactionShares" bson:"postTransactionShares"`
	BuyOrSell             string        `json:"buyOrSell" bson:"buyOrSell"`
	Url                   string        `json:"url" bson:"url"`
	DateAdded             string        `json:"dateAdded" bson:"dateAdded"`
	Issuer                DB_Issuer     `json:"issuer" bson:"issuer"`
	Reporters             []DB_Reporter `json:"reporters" bson:"reporters"`
}

type DB_DerivativeTransaction

type DB_DerivativeTransaction struct {
	SecurityTitle                   string  `json:"securityTitle" bson:"securityTitle"`
	TransactionDate                 string  `json:"transactionDate" bson:"transactionDate"`
	ConversionOrExercisePrice       float32 `json:"conversionOrExercisePrice" bson:"conversionOrExercisePrice"`
	DeemedExecutionDate             string  `json:"deemedExecutionDate" bson:"deemedExecutionDate"`
	TransactionCode                 string  `json:"transactionCode" bson:"transactionCode"`
	TransactionShares               float32 `json:"transactionShares" bson:"transactionShares"`
	TransactionPricePerShare        float32 `json:"transactionPricePerShare" bson:"transactionPricePerShare"`
	TransactionAcquiredDisposedCode string  `json:"transactionAcquiredDisposedCode" bson:"transactionAcquiredDisposedCode"`
	ExerciseDate                    string  `json:"exerciseDate" bson:"exerciseDate"`
	PostTransactionShares           float32 `json:"postTransactionShares" bson:"postTransactionShares"`
	ExpirationDate                  string  `json:"expirationDate" bson:"expirationDate"`
}

type DB_FeaturedIssuer added in v1.0.4

type DB_FeaturedIssuer struct {
	Index            int     `bson:"index"`
	Cik              string  `bson:"cik"`
	NetTotal         float32 `bson:"netTotal"`
	NumberOfInsiders int     `bson:"numberOfInsiders"`
	Name             string  `bson:"name"`
	Ticker           string  `bson:"ticker"`
	MostRecentDate   string  `bson:"mostRecentDate"`
	CompanyValue     float32 `bson:"companyValue"`
}

type DB_Form13F_Base

type DB_Form13F_Base struct {
	Cik             string               `json:"cik" bson:"cik"`
	ReporterName    string               `json:"reporterName" bson:"reporterName"`
	AccessionNumber string               `json:"accessionNumber" bson:"accessionNumber"`
	PeriodOfReport  string               `json:"periodOfReport" bson:"periodOfReport"`
	Url             string               `json:"url" bson:"url"`
	TotalHeld       float32              `json:"totalHeld" bson:"totalHeld"`
	Holdings        []DB_Form13F_Holding `json:"holdings" bson:"holdings"`
}

type DB_Form13F_Holding

type DB_Form13F_Holding struct {
	Name     string  `json:"name" bson:"name"`
	Shares   float32 `json:"shares" bson:"shares"`
	NetTotal float32 `json:"netTotal" bson:"netTotal"`
	Cik      string  `json:"cik" bson:"cik"`
}

this can be an issuer or a reporter

type DB_Form13F_ISSUER

type DB_Form13F_ISSUER struct {
	Cik           string               `json:"cik" bson:"cik"`
	IssuerName    string               `json:"issuerName" bson:"issuerName"`
	IssuerTickers []string             `json:"issuerTickers" bson:"issuerTickers"`
	Holdings      []DB_Form13F_Holding `json:"holdings" bson:"holdings"`
}

type DB_Issuer

type DB_Issuer struct {
	IssuerCik      string `json:"issuerCik" bson:"issuerCik"`
	IssuerName     string `json:"issuerName" bson:"issuerName"`
	IssuerTicker   string `json:"issuerTicker" bson:"issuerTicker"`
	IssuerSector   string `json:"issuerSector" bson:"issuerSector"`
	IssuerIndustry string `json:"issuerIndustry" bson:"issuerIndustry"`
}

type DB_Issuer_Doc

type DB_Issuer_Doc struct {
	Name                 string      `json:"name" bson:"name"`
	Cik                  string      `json:"cik" bson:"cik"`
	Sic                  string      `json:"sic" bson:"sic"`
	SicDescription       string      `json:"secDescription" bson:"secDescription"`
	Ein                  string      `json:"ein" bson:"ein"`
	Tickers              []string    `json:"tickers" bson:"tickers"`
	Exchanges            []string    `json:"exchanges" bson:"exchanges"`
	FiscalYearEnd        string      `json:"fiscalYearEnd" bson:"fiscalYearEnd"`
	StateOfIncorporation string      `json:"stateOfIncorporation" bson:"stateOfIncorporation"`
	Phone                string      `json:"phone" bson:"phone"`
	StockData            []StockData `json:"stockData" bson:"stockData"`
	StockDataSplit       bool        `json:"stockDataSplit" bson:"stockDataSplit"`
	Splits               []Split     `json:"splits" bson:"splits"`
	Sector               string      `json:"sector" bson:"sector"`
	Industry             string      `json:"industry" bson:"industry"`
}

type DB_NonDerivativeTransaction

type DB_NonDerivativeTransaction struct {
	SecurityTitle                   string  `json:"securityTitle" bson:"securityTitle"`
	TransactionDate                 string  `json:"transactionDate" bson:"transactionDate"`
	TransactionCode                 string  `json:"transactionCode" bson:"transactionCode"`
	TransactionShares               float32 `json:"transactionShares" bson:"transactionShares"`
	TransactionPricePerShare        float32 `json:"transactionPricePerShare" bson:"transactionPricePerShare"`
	TransactionAcquiredDisposedCode string  `json:"transactionAcquiredDisposedCode" bson:"transactionAcquiredDisposedCode"`
	PostTransactionShares           float32 `json:"postTransactionShares" bson:"postTransactionShares"`
}

type DB_Reporter

type DB_Reporter struct {
	ReporterCik     string `json:"reporterCik" bson:"reporterCik"`
	ReporterName    string `json:"reporterName" bson:"reporterName"`
	ReporterTitle   string `json:"reporterTitle" bson:"reporterTitle"`
	ReporterAddress string `json:"reporterAddress" bson:"reporterAddress"`
}

type DB_Reporter_Doc

type DB_Reporter_Doc struct {
	Name          string  `json:"name" bson:"name"`
	Cik           string  `json:"cik" bson:"cik"`
	IsCongressman bool    `json:"isCongressman" bson:"isCongressman"`
	Party         string  `json:"party" bson:"party"`
	IsInst        bool    `json:"isInst" bson:"isInst" default:"false"`
	Last13FTotal  float64 `json:"last13FTotal" bson:"last13FTotal" default:"0"`
}

type DB_Sector added in v1.0.1

type DB_Sector struct {
	Id             DB_Sector_Id           `json:"_id" bson:"_id"`
	HistoricalData []DB_Sector_Historical `json:"historicalData" bson:"historicalData"`
}

type DB_Sector_Historical added in v1.0.1

type DB_Sector_Historical struct {
	Date        string  `json:"date" bson:"date"`
	Total       float64 `json:"total" bson:"total"`
	TotalBought float64 `json:"totalBought" bson:"totalBought"`
	TotalSold   float64 `json:"totalSold" bson:"totalSold"`
	BuyOrSell   string  `json:"buyOrSell" bson:"buyOrSell"`
}

type DB_Sector_Id added in v1.0.5

type DB_Sector_Id struct {
	Name string `json:"name" bson:"name"`
}

type DB_SentimentDay added in v1.0.3

type DB_SentimentDay struct {
	Buy  float32 `bson:"buy"`
	Sell float32 `bson:"sell"`
	Date string  `bson:"date"`
}

type DeemedExecutionDate

type DeemedExecutionDate struct {
	XMLName xml.Name `xml:"deemedExecutionDate"`
	Value   string   `xml:"value"`
}

type DerivativeHolding

type DerivativeHolding struct {
	XMLName                   xml.Name `xml:"derivativeHolding"`
	DerivativeTableID         uint
	SecurityTitle             SecurityTitle             `xml:"securityTitle" `
	ConversionOrExercisePrice ConversionOrExercisePrice `xml:"conversionOrExercisePrice" `
	ExerciseDate              ExerciseDate              `xml:"exerciseDate" `
	ExpirationDate            ExpirationDate            `xml:"expirationDate" `
	UnderlyingSecurity        UnderlyingSecurity        `xml:"underlyingSecurity" `
	PostTransactionAmounts    PostTransactionAmounts    `xml:"postTransactionAmounts" `
	OwnershipNature           OwnershipNature           `xml:"ownershipNature" `
}

type DerivativeTable

type DerivativeTable struct {
	XMLName                xml.Name                `xml:"derivativeTable"`
	DerivativeTransactions []DerivativeTransaction `xml:"derivativeTransaction" `
	DerivativeHoldings     []DerivativeHolding     `xml:"derivativeHolding" `
}

type DerivativeTransaction

type DerivativeTransaction struct {
	XMLName                   xml.Name `xml:"derivativeTransaction"`
	DerivativeTableID         uint
	SecurityTitle             SecurityTitle             `xml:"securityTitle"`
	ConversionOrExercisePrice ConversionOrExercisePrice `xml:"conversionOrExercisePrice" `
	TransactionDate           TransactionDate           `xml:"transactionDate"`
	DeemedExecutionDate       DeemedExecutionDate       `xml:"deemedExecutionDate" `
	TransactionCoding         TransactionCoding         `xml:"transactionCoding"`
	TransactionTimeliness     TransactionTimeliness     `xml:"transactionTimeliness"`
	TransactionAmounts        TransactionAmounts        `xml:"transactionAmounts"`
	ExerciseDate              ExerciseDate              `xml:"exerciseDate"`
	ExpirationDate            ExpirationDate            `xml:"expirationDate" `
	UnderlyingSecurity        UnderlyingSecurity        `xml:"underlyingSecurity"`
	PostTransactionAmounts    PostTransactionAmounts    `xml:"postTransactionAmounts" `
	OwnershipNature           OwnershipNature           `xml:"ownershipNature"`
}

type DirectOrIndirectOwnership

type DirectOrIndirectOwnership struct {
	XMLName xml.Name `xml:"directOrIndirectOwnership"`
	Value   string   `xml:"value"`
}

type ExerciseDate

type ExerciseDate struct {
	XMLName xml.Name `xml:"exerciseDate"`
	Value   string   `xml:"value"`
}

type ExpirationDate

type ExpirationDate struct {
	XMLName xml.Name `xml:"expirationDate"`
	Value   string   `xml:"value"`
}

type Issuer

type Issuer struct {
	XMLName             xml.Name `xml:"issuer" json:"-"`
	IssuerCIK           string   `xml:"issuerCik"`
	IssuerName          string   `xml:"issuerName"`
	IssuerTradingSymbol string   `xml:"issuerTradingSymbol"`
}

type NatureOfOwnership

type NatureOfOwnership struct {
	XMLName xml.Name `xml:"natureOfOwnership"`
	Value   string   `xml:"value"`
}

type NonDerivativeHolding

type NonDerivativeHolding struct {
	XMLName                xml.Name               `xml:"nonDerivativeHolding"`
	SecurityTitle          SecurityTitle          `xml:"securityTitle" `
	PostTransactionAmounts PostTransactionAmounts `xml:"postTransactionAmounts" `
	OwnershipNature        OwnershipNature        `xml:"ownershipNature" `
}

type NonDerivativeTable

type NonDerivativeTable struct {
	XMLName                   xml.Name                   `xml:"nonDerivativeTable"`
	NonDerivativeTransactions []NonDerivativeTransaction `xml:"nonDerivativeTransaction" `
	NonDerivativeHoldings     []NonDerivativeHolding     `xml:"nonDerivativeHolding"`
}

type NonDerivativeTransaction

type NonDerivativeTransaction struct {
	XMLName                xml.Name               `xml:"nonDerivativeTransaction"`
	SecurityTitle          SecurityTitle          `xml:"securityTitle" `
	TransactionDate        TransactionDate        `xml:"transactionDate" `
	DeemedExecutionDate    DeemedExecutionDate    `xml:"deemedExecutionDate" `
	TransactionCoding      TransactionCoding      `xml:"transactionCoding" `
	TransactionTimeliness  TransactionTimeliness  `xml:"transactionTimeliness" `
	TransactionAmounts     TransactionAmounts     `xml:"transactionAmounts" `
	PostTransactionAmounts PostTransactionAmounts `xml:"postTransactionAmounts" `
	OwnershipNature        OwnershipNature        `xml:"ownershipNature" `
}

type OwnerSignature

type OwnerSignature struct {
	XMLName       xml.Name `xml:"ownerSignature"`
	SignatureName string   `xml:"signatureName"`
	SignatureDate string   `xml:"signatureDate"`
}

type OwnershipNature

type OwnershipNature struct {
	XMLName                   xml.Name                  `xml:"ownershipNature"`
	DirectOrIndirectOwnership DirectOrIndirectOwnership `xml:"directOrIndirectOwnership" `
	NatureOfOwnership         NatureOfOwnership         `xml:"natureOfOwnership" `
}

type PostTransactionAmounts

type PostTransactionAmounts struct {
	XMLName                         xml.Name                        `xml:"postTransactionAmounts"`
	SharesOwnedFollowingTransaction SharesOwnedFollowingTransaction `xml:"sharesOwnedFollowingTransaction" `
	ValueOwnedFollowingTransaction  ValueOwnedFollowingTransaction  `xml:"valueOwnedFollowingTransaction" `
}

type RawForm4

type RawForm4 struct {
	XMLName                  xml.Name           `xml:"ownershipDocument" json:"-"`
	SchemaVersion            string             `xml:"schemaVersion"`
	DocumentType             string             `xml:"documentType"`
	PeriodOfReport           string             `xml:"periodOfReport"`
	DateOfOriginalSubmission string             `xml:"dateOfOriginalSubmission"`
	NoSecuritiesOwned        bool               `xml:"noSecuritiesOwned"`
	AccessionNumber          string             `xml:"accessionNumber"`
	Url                      string             `xml:"url"`
	Issuer                   Issuer             `xml:"issuer"`
	ReportingOwners          []ReportingOwner   `xml:"reportingOwner" json:"ReportingOwners"`
	NonDerivativeTable       NonDerivativeTable `xml:"nonDerivativeTable"`
	DerivativeTable          DerivativeTable    `xml:"derivativeTable"`
	OwnerSignatures          []OwnerSignature   `xml:"ownerSignature" `
}

type ReportingOwner

type ReportingOwner struct {
	XMLName                    xml.Name                   `xml:"reportingOwner"`
	ReportingOwnerId           ReportingOwnerId           `xml:"reportingOwnerId"`
	ReportingOwnerAddress      ReportingOwnerAddress      `xml:"reportingOwnerAddress" `
	ReportingOwnerRelationship ReportingOwnerRelationship `xml:"reportingOwnerRelationship" `
}

type ReportingOwnerAddress

type ReportingOwnerAddress struct {
	XMLName                  xml.Name `xml:"reportingOwnerAddress"`
	RptOwnerStreet1          string   `xml:"rptOwnerStreet1"`
	RptOwnerStreet2          string   `xml:"rptOwnerStreet2"`
	RptOwnerCity             string   `xml:"rptOwnerCity"`
	RptOwnerState            string   `xml:"rptOwnerState"`
	RptOwnerZipCode          string   `xml:"rptOwnerZipCode"`
	RptOwnerStateDescription string   `xml:"rptOwnerStateDescription"`
}

type ReportingOwnerId

type ReportingOwnerId struct {
	XMLName      xml.Name `xml:"reportingOwnerId"`
	RptOwnerCik  string   `xml:"rptOwnerCik"`
	RptOwnerCcc  string   `xml:"rptOwnerCcc"`
	RptOwnerName string   `xml:"rptOwnerName"`
}

type ReportingOwnerRelationship

type ReportingOwnerRelationship struct {
	XMLName           xml.Name `xml:"reportingOwnerRelationship"`
	IsDirector        bool     `xml:"isDirector"`
	IsOfficer         bool     `xml:"isOfficer"`
	IsTenPercentOwner bool     `xml:"isTenPercentOwner"`
	IsOther           bool     `xml:"isOther"`
	OfficerTitle      string   `xml:"officerTitle"`
	OtherText         string   `xml:"otherText"`
}

type SecApiResponse

type SecApiResponse struct {
	Cik                             string   `json:"cik"`
	EntityType                      string   `json:"entityType"`
	Sic                             string   `json:"sic"`
	SicDescription                  string   `json:"sicDescription"`
	IsReporter                      int      `json:"insiderTransactionForOwnerExists"`
	IsIssuer                        int      `json:"insiderTransactionForIssuerExists"`
	Name                            string   `json:"name"`
	Ein                             string   `json:"ein"`
	Tickers                         []string `json:"tickers"`
	Exchanges                       []string `json:"exchanges"`
	Description                     string   `json:"description"`
	Website                         string   `json:"website"`
	InvestorWebsite                 string   `json:"InvestorWebsite"`
	Category                        string   `json:"category"`
	FiscalYearEnd                   string   `json:"fiscalYearEnd"`
	StateOfIncorporation            string   `json:"stateOfIncorporation"`
	StateOfIncorporationDescription string   `json:"stateOfIncorporationDescription"`
	Phone                           string   `json:"phone"`
	Flags                           string   `json:"flags"`
	Filings                         filings  `json:"filings"`
}

type SecurityTitle

type SecurityTitle struct {
	XMLName xml.Name `xml:"securityTitle"`
	Value   string   `xml:"value"`
}

type SharesOwnedFollowingTransaction

type SharesOwnedFollowingTransaction struct {
	XMLName xml.Name `xml:"sharesOwnedFollowingTransaction"`
	Value   float32  `xml:"value"`
}

type Split

type Split struct {
	Date  string `json:"date" bson:"date"`
	Split string `json:"split" bson:"split"`
}

type StockData

type StockData struct {
	Date   string  `json:"date" bson:"date"`
	Close  float64 `json:"close" bson:"close"`
	Volume int     `json:"volume" bson:"volume"`
}

type Top_From_Sector added in v1.0.6

type Top_From_Sector struct {
	Sector    string                  `json:"sector" bson:"sector"`
	Companies []Top_From_Sector_Entry `json:"companies" bson:"companies"`
}

type Top_From_Sector_Entry added in v1.0.6

type Top_From_Sector_Entry struct {
	Id          string  `json:"_id" bson:"_id"`
	Ticker      string  `json:"ticker" bson:"ticker"`
	Name        string  `json:"name" bson:"name"`
	Industry    string  `json:"industry" bson:"industry"`
	TradeVolume float64 `json:"tradeVolume" bson:"tradeVolume"`
}

fix?

type TransactionAcquiredDisposedCode

type TransactionAcquiredDisposedCode struct {
	XMLName xml.Name `xml:"transactionAcquiredDisposedCode"`
	Value   string   `xml:"value"`
}

type TransactionAmounts

type TransactionAmounts struct {
	XMLName                         xml.Name                        `xml:"transactionAmounts"`
	TransactionShares               TransactionShares               `xml:"transactionShares" `
	TransactionTotalValue           TransactionTotalValue           `xml:"transactionTotalValue" `
	TransactionPricePerShare        TransactionPricePerShare        `xml:"transactionPricePerShare" `
	TransactionAcquiredDisposedCode TransactionAcquiredDisposedCode `xml:"transactionAcquiredDisposedCode" `
}

type TransactionCoding

type TransactionCoding struct {
	XMLName             xml.Name `xml:"transactionCoding"`
	TransactionFormType string   `xml:"transactionFormType" `
	TransactionCode     string   `xml:"transactionCode"`
	EquitySwapInvolved  bool     `xml:"equitySwapInvolved" `
}

type TransactionDate

type TransactionDate struct {
	XMLName xml.Name `xml:"transactionDate"`
	Value   string   `xml:"value"`
}

type TransactionPricePerShare

type TransactionPricePerShare struct {
	XMLName xml.Name `xml:"transactionPricePerShare"`
	Value   float32  `xml:"value"`
}

type TransactionShares

type TransactionShares struct {
	XMLName xml.Name `xml:"transactionShares"`
	Value   float32  `xml:"value"`
}

type TransactionTimeliness

type TransactionTimeliness struct {
	XMLName xml.Name `xml:"transactionTimeliness"`
	Value   string   `xml:"value"`
}

type TransactionTotalValue

type TransactionTotalValue struct {
	XMLName xml.Name `xml:"transactionTotalValue"`
	Value   string   `xml:"value"`
}

type UnderlyingSecurity

type UnderlyingSecurity struct {
	XMLName                  xml.Name                 `xml:"underlyingSecurity"`
	UnderlyingSecurityTitle  UnderlyingSecurityTitle  `xml:"underlyingSecurityTitle" `
	UnderlyingSecurityShares UnderlyingSecurityShares `xml:"underlyingSecurityShares" `
	UnderlyingSecurityValue  UnderlyingSecurityValue  `xml:"underlyingSecurityValue" `
}

type UnderlyingSecurityShares

type UnderlyingSecurityShares struct {
	XMLName xml.Name `xml:"underlyingSecurityShares"`
	Value   string   `xml:"value"`
}

type UnderlyingSecurityTitle

type UnderlyingSecurityTitle struct {
	XMLName xml.Name `xml:"underlyingSecurityTitle"`
	Value   string   `xml:"value"`
}

type UnderlyingSecurityValue

type UnderlyingSecurityValue struct {
	XMLName xml.Name `xml:"underlyingSecurityValue"`
	Value   string   `xml:"value"`
}

type ValueOwnedFollowingTransaction

type ValueOwnedFollowingTransaction struct {
	XMLName xml.Name `xml:"valueOwnedFollowingTransaction"`
	Value   string   `xml:"value"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL