Skip to content

Commit

Permalink
Add filter params
Browse files Browse the repository at this point in the history
  • Loading branch information
@justinpolygon
justinpolygon committed Oct 11, 2024
1 parent a1cd026 commit 2b630a3
Show file tree
Hide file tree
Showing 5 changed files with 193 additions and 125 deletions.
7 changes: 2 additions & 5 deletions rest/example/stocks/company-ipos/main.go → rest/example/stocks/ipos/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,8 @@ func main() {
// Initialize client
c := polygon.New(os.Getenv("POLYGON_API_KEY"))

// Set parameters (optional)
params := models.ListIPOsParams{}.
WithLimit(1).
WithOrder(models.Asc).
WithSort(models.IPOsSortListingDate)
// Set parameters
params := models.ListIPOsParams{}.WithTicker("RDDT")

// make request
iter := c.ListIPOs(context.Background(), params)
Expand Down
22 changes: 14 additions & 8 deletions rest/example/stocks/short-interest/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"context"
"log"
"os"
"time"

polygon "github.com/polygon-io/client-go/rest"
"github.com/polygon-io/client-go/rest/models"
Expand All @@ -17,17 +18,22 @@ func main() {
c := polygon.New(os.Getenv("POLYGON_API_KEY"))

// Set parameters
params := models.GetShortInterestParams{
params := models.ListShortInterestParams{
IdentifierType: "ticker",
Identifier: "AAPL",
}
Identifier: "AMD",
}.WithDay(models.GTE, 2024, time.October, 1).
WithDay(models.LTE, 2024, time.October, 10).
WithLimit(10)

// Make request
res, err := c.GetShortInterest(context.Background(), &params)
if err != nil {
log.Fatal(err)
iter := c.ListShortInterest(context.Background(), params)

// Do something with the result
for iter.Next() {
log.Print(iter.Item())
}
if iter.Err() != nil {
log.Fatal(iter.Err())
}

// Handle the result
log.Print(res)
}
149 changes: 97 additions & 52 deletions rest/models/tickers.go
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
package models

import "strings"
import (
"strings"
"time"
)

// ListTickersParams is the set of parameters for the ListTickers method.
type ListTickersParams struct {
Expand Down Expand Up @@ -421,51 +424,66 @@ type TickerChangeEvent struct {
Ticker string `json:"ticker"`
}

// GetShortInterestParams contains parameters for the GetShortInterest method.
type GetShortInterestParams struct {
// ListShortInterestParams contains parameters for the ListShortInterest method.
type ListShortInterestParams struct {
// Path parameters
IdentifierType string `validate:"required" path:"identifierType"`
Identifier string `validate:"required" path:"identifier"`

// Query parameters
Date *string `query:"date,omitempty"`
Order *string `query:"order,omitempty"`
Limit *int `query:"limit,omitempty"`
Sort *string `query:"sort,omitempty"`
DateEQ *Nanos `query:"date"`
DateLT *Nanos `query:"date.lt"`
DateLTE *Nanos `query:"date.lte"`
DateGT *Nanos `query:"date.gt"`
DateGTE *Nanos `query:"date.gte"`

Order *Order `query:"order"`
Limit *int `query:"limit"`
Sort *Sort `query:"sort"`
}

// WithDate sets the optional Date parameter.
func (p GetShortInterestParams) WithDate(date string) *GetShortInterestParams {
p.Date = &date
// WithDate adds date filtering to the parameters.
func (p ListShortInterestParams) WithDate(c Comparator, q Nanos) *ListShortInterestParams {
switch c {
case EQ:
p.DateEQ = &q
case LT:
p.DateLT = &q
case LTE:
p.DateLTE = &q
case GT:
p.DateGT = &q
case GTE:
p.DateGTE = &q
}
return &p
}

// WithOrder sets the optional Order parameter.
func (p GetShortInterestParams) WithOrder(order string) *GetShortInterestParams {
// WithDay allows setting the date via year, month, day.
func (p ListShortInterestParams) WithDay(c Comparator, year int, month time.Month, day int) *ListShortInterestParams {
d := Nanos(time.Date(year, month, day, 0, 0, 0, 0, time.UTC))
return p.WithDate(c, d)
}

func (p ListShortInterestParams) WithOrder(order Order) *ListShortInterestParams {
p.Order = &order
return &p
}

// WithLimit sets the optional Limit parameter.
func (p GetShortInterestParams) WithLimit(limit int) *GetShortInterestParams {
func (p ListShortInterestParams) WithLimit(limit int) *ListShortInterestParams {
p.Limit = &limit
return &p
}

// WithSort sets the optional Sort parameter.
func (p GetShortInterestParams) WithSort(sort string) *GetShortInterestParams {
func (p ListShortInterestParams) WithSort(sort Sort) *ListShortInterestParams {
p.Sort = &sort
return &p
}

// GetShortInterestResponse represents the response from the GetShortInterest method.
type GetShortInterestResponse struct {
// ListShortInterestResponse represents the response from the ListShortInterest method.
type ListShortInterestResponse struct {
BaseResponse

NextURL string `json:"next_url,omitempty"`
RequestID string `json:"request_id,omitempty"`
Results []ShortInterest `json:"results,omitempty"`
Status string `json:"status,omitempty"`
Results []ShortInterest `json:"results,omitempty"`
}

// ShortInterest represents a single short interest data point.
Expand All @@ -485,62 +503,93 @@ type ShortInterest struct {
type IPOsSortField string

const (
IPOsSortTicker IPOsSortField = "ticker"
IPOsSortListingDate IPOsSortField = "listing_date"
IPOsSortUsCode IPOsSortField = "us_code"
IPOsSortIsin IPOsSortField = "isin"
IPOsSortIssueEndDate IPOsSortField = "issue_end_date"
IPOsSortListingDate IPOsSortField = "listing_date"
IPOsSortTicker IPOsSortField = "ticker"
IPOsSortLastUpdated IPOsSortField = "last_updated"
IPOsSortSecurityType IPOsSortField = "security_type"
IPOsSortIssuerName IPOsSortField = "issuer_name"
IPOsSortCurrencyCode IPOsSortField = "currency_code"
IPOsSortISIN IPOsSortField = "isin"
IPOsSortUSCode IPOsSortField = "us_code"
IPOsSortFinalIssuePrice IPOsSortField = "final_issue_price"
IPOsSortMinSharesOffered IPOsSortField = "min_shares_offered"
IPOsSortMaxSharesOffered IPOsSortField = "max_shares_offered"
IPOsSortLowestOfferPrice IPOsSortField = "lowest_offer_price"
IPOsSortHighestOfferPrice IPOsSortField = "highest_offer_price"
IPOsSortTotalOfferSize IPOsSortField = "total_offer_size"
IPOsSortSharesOutstanding IPOsSortField = "shares_outstanding"
IPOsSortPrimaryExchange IPOsSortField = "primary_exchange"
IPOsSortLotSize IPOsSortField = "lot_size"
IPOsSortSecurityDescription IPOsSortField = "security_description"
IPOsSortIPOStatus IPOsSortField = "ipo_status"
)

// ListIPOsParams contains parameters for the ListIPOs method.
type ListIPOsParams struct {
// Query parameters
Ticker *string `query:"ticker,omitempty"`
USCode *string `query:"us_code,omitempty"`
ISIN *string `query:"isin,omitempty"`
ListingDate *string `query:"listing_date,omitempty"`
Order *Order `query:"order,omitempty"`
Limit *int `query:"limit,omitempty"`
Sort *IPOsSortField `query:"sort,omitempty"`
Ticker *string `query:"ticker"`
USCode *string `query:"us_code"`
ISIN *string `query:"isin"`

ListingDateEQ *Nanos `query:"listing_date"`
ListingDateLT *Nanos `query:"listing_date.lt"`
ListingDateLTE *Nanos `query:"listing_date.lte"`
ListingDateGT *Nanos `query:"listing_date.gt"`
ListingDateGTE *Nanos `query:"listing_date.gte"`

Order *Order `query:"order"`
Limit *int `query:"limit"`
Sort *IPOsSortField `query:"sort"`
}

// WithListingDate adds listing date filtering to the parameters.
func (p ListIPOsParams) WithListingDate(c Comparator, q Nanos) *ListIPOsParams {
switch c {
case EQ:
p.ListingDateEQ = &q
case LT:
p.ListingDateLT = &q
case LTE:
p.ListingDateLTE = &q
case GT:
p.ListingDateGT = &q
case GTE:
p.ListingDateGTE = &q
}
return &p
}

// WithListingDay allows setting the listing date via year, month, day.
func (p ListIPOsParams) WithListingDay(c Comparator, year int, month time.Month, day int) *ListIPOsParams {
d := Nanos(time.Date(year, month, day, 0, 0, 0, 0, time.UTC))
return p.WithListingDate(c, d)
}

// WithTicker sets the Ticker parameter.
func (p ListIPOsParams) WithTicker(ticker string) *ListIPOsParams {
p.Ticker = &ticker
return &p
}

// WithUSCode sets the USCode parameter.
func (p ListIPOsParams) WithUSCode(usCode string) *ListIPOsParams {
p.USCode = &usCode
return &p
}

// WithISIN sets the ISIN parameter.
func (p ListIPOsParams) WithISIN(isin string) *ListIPOsParams {
p.ISIN = &isin
return &p
}

// WithListingDate sets the ListingDate parameter.
func (p ListIPOsParams) WithListingDate(listingDate string) *ListIPOsParams {
p.ListingDate = &listingDate
return &p
}

// WithOrder sets the Order parameter.
func (p ListIPOsParams) WithOrder(order Order) *ListIPOsParams {
p.Order = &order
return &p
}

// WithLimit sets the Limit parameter.
func (p ListIPOsParams) WithLimit(limit int) *ListIPOsParams {
p.Limit = &limit
return &p
}

// WithSort sets the Sort parameter.
func (p ListIPOsParams) WithSort(sort IPOsSortField) *ListIPOsParams {
p.Sort = &sort
return &p
Expand All @@ -549,11 +598,7 @@ func (p ListIPOsParams) WithSort(sort IPOsSortField) *ListIPOsParams {
// ListIPOsResponse represents the response from the ListIPOs method.
type ListIPOsResponse struct {
BaseResponse

NextURL string `json:"next_url,omitempty"`
RequestID string `json:"request_id,omitempty"`
Results []IPOListing `json:"results,omitempty"`
Status string `json:"status,omitempty"`
Results []IPOListing `json:"results,omitempty"`
}

// IPOListing represents a single IPO listing.
Expand Down
44 changes: 19 additions & 25 deletions rest/reference.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,21 @@ import (
)

const (
ListTickersPath = "/v3/reference/tickers"
GetExchangesPath = "/v3/reference/exchanges"
GetMarketHolidaysPath = "/v1/marketstatus/upcoming"
GetMarketStatusPath = "/v1/marketstatus/now"
GetOptionsContractPath = "/v3/reference/options/contracts/{ticker}"
GetTickerDetailsPath = "/v3/reference/tickers/{ticker}"
ListTickerNewsPath = "/v2/reference/news"
GetTickerRelatedCompaniesPath = "/v1/related-companies/{ticker}"
GetTickerTypesPath = "/v3/reference/tickers/types"

GetShortInterestPath = "/v1/reference/short-interest/{identifierType}/{identifier}"

ListIPOsPath = "/v1/reference/ipos"

GetMarketHolidaysPath = "/v1/marketstatus/upcoming"
GetMarketStatusPath = "/v1/marketstatus/now"

ListSplitsPath = "/v3/reference/splits"

ListDividendsPath = "/v3/reference/dividends"

ListConditionsPath = "/v3/reference/conditions"

GetExchangesPath = "/v3/reference/exchanges"

GetOptionsContractPath = "/v3/reference/options/contracts/{ticker}"
ListOptionsContractsPath = "/v3/reference/options/contracts"
ListConditionsPath = "/v3/reference/conditions"
ListDividendsPath = "/v3/reference/dividends"
ListIPOsPath = "/vX/reference/ipos"
ListOptionsContractsPath = "/v3/reference/options/contracts"
ListShortInterestPath = "/vX/reference/short-interest/{identifierType}/{identifier}"
ListSplitsPath = "/v3/reference/splits"
ListTickerNewsPath = "/v2/reference/news"
ListTickersPath = "/v3/reference/tickers"
)

// ReferenceClient defines a REST client for the Polygon reference API.
Expand Down Expand Up @@ -215,12 +207,14 @@ func (c *ReferenceClient) ListOptionsContracts(ctx context.Context, params *mode
})
}

// GetShortInterest retrieves short interest data for a given identifier and date.
// ListShortInterest retrieves short interest data for a given identifier and date.
// For more details, see: https://polygon.io/docs/stocks/get_v1_reference_short-interest__identifiertype___identifier
func (c *ReferenceClient) GetShortInterest(ctx context.Context, params *models.GetShortInterestParams, options ...models.RequestOption) (*models.GetShortInterestResponse, error) {
res := &models.GetShortInterestResponse{}
err := c.Call(ctx, http.MethodGet, GetShortInterestPath, params, res, options...)
return res, err
func (c *ReferenceClient) ListShortInterest(ctx context.Context, params *models.ListShortInterestParams, options ...models.RequestOption) *iter.Iter[models.ShortInterest] {
return iter.NewIter(ctx, ListShortInterestPath, params, func(uri string) (iter.ListResponse, []models.ShortInterest, error) {
res := &models.ListShortInterestResponse{}
err := c.CallURL(ctx, http.MethodGet, uri, res, options...)
return res, res.Results, err
})
}

// ListIPOs retrieves a list of upcoming or historical IPOs.
Expand Down
Loading

0 comments on commit 2b630a3

Please sign in to comment.