Adds IPOs, Short Interest/Volume, and Treasury Yields (#529)

Author: justinpolygon

rest/example/economy/treasury-yields/main.go

@@ -0,0 +1,33 @@
+package main
+
+import (
+	"context"
+	"log"
+	"os"
+
+	polygon "github.com/polygon-io/client-go/rest"
+	"github.com/polygon-io/client-go/rest/models"
+)
+
+func main() {
+	// Initialize client
+	c := polygon.New(os.Getenv("POLYGON_API_KEY"))
+
+	// Set parameters
+	params := models.ListTreasuryYieldsParams{}.
+		WithDate(models.GTE, "2024-12-15").
+		WithDate(models.LTE, "2024-12-31").
+		WithOrder(models.Asc).
+		WithLimit(50000)
+
+	// Make request
+	iter := c.VX.ListTreasuryYields(context.Background(), params)
+
+	// Process results
+	for iter.Next() {
+		log.Print(iter.Item())
+	}
+	if iter.Err() != nil {
+		log.Fatal(iter.Err())
+	}
+}

rest/example/stocks/ipos/main.go

@@ -0,0 +1,33 @@
+package main
+
+import (
+	"context"
+	"log"
+	"os"
+
+	polygon "github.com/polygon-io/client-go/rest"
+	"github.com/polygon-io/client-go/rest/models"
+)
+
+func main() {
+	// Initialize client
+	c := polygon.New(os.Getenv("POLYGON_API_KEY"))
+
+	// Set parameters
+	params := models.ListIPOsParams{}.
+		WithTicker("RAPP").
+		WithListingDate(models.EQ, "2024-06-07").
+		WithOrder(models.Desc).
+		WithLimit(1000)
+
+	// Make request
+	iter := c.VX.ListIPOs(context.Background(), params)
+
+	// Process results
+	for iter.Next() {
+		log.Print(iter.Item())
+	}
+	if iter.Err() != nil {
+		log.Fatal(iter.Err())
+	}
+}

rest/example/stocks/short-interest/main.go

@@ -0,0 +1,33 @@
+package main
+
+import (
+	"context"
+	"log"
+	"os"
+
+	polygon "github.com/polygon-io/client-go/rest"
+	"github.com/polygon-io/client-go/rest/models"
+)
+
+func main() {
+	// Initialize client
+	c := polygon.New(os.Getenv("POLYGON_API_KEY"))
+
+	// Set parameters
+	params := models.ListShortInterestParams{}.
+		WithTicker(models.EQ, "A").
+		WithSettlementDate(models.EQ, "2025-03-14").
+		WithOrder(models.Asc).
+		WithLimit(50000)
+
+	// Make request
+	iter := c.VX.ListShortInterest(context.Background(), params)
+
+	// Process results
+	for iter.Next() {
+		log.Print(iter.Item())
+	}
+	if iter.Err() != nil {
+		log.Fatal(iter.Err())
+	}
+}

rest/example/stocks/short-volume/main.go

@@ -0,0 +1,33 @@
+package main
+
+import (
+	"context"
+	"log"
+	"os"
+
+	polygon "github.com/polygon-io/client-go/rest"
+	"github.com/polygon-io/client-go/rest/models"
+)
+
+func main() {
+	// Initialize client
+	c := polygon.New(os.Getenv("POLYGON_API_KEY"))
+
+	// Set parameters
+	params := models.ListShortVolumeParams{}.
+		WithTicker(models.EQ, "A").
+		WithDate(models.EQ, "2025-03-25").
+		WithOrder(models.Asc).
+		WithLimit(50000)
+
+	// Make request
+	iter := c.VX.ListShortVolume(context.Background(), params)
+
+	// Process results
+	for iter.Next() {
+		log.Print(iter.Item())
+	}
+	if iter.Err() != nil {
+		log.Fatal(iter.Err())
+	}
+}

rest/models/economy.go

@@ -0,0 +1,75 @@
+package models
+
+// ListTreasuryYieldsParams is the set of parameters for the ListTreasuryYields method.
+type ListTreasuryYieldsParams struct {
+	// Calendar date of the yield observation (YYYY-MM-DD).
+	DateEQ  *string `query:"date"`
+	DateLT  *string `query:"date.lt"`
+	DateLTE *string `query:"date.lte"`
+	DateGT  *string `query:"date.gt"`
+	DateGTE *string `query:"date.gte"`
+
+	// Sort field used for ordering. Default is date.
+	Sort *Sort `query:"sort"`
+
+	// Order results based on the sort field. Default is asc.
+	Order *Order `query:"order"`
+
+	// Limit the number of results returned, default is 100 and max is 50000.
+	Limit *int `query:"limit"`
+}
+
+func (p ListTreasuryYieldsParams) WithDate(c Comparator, q string) *ListTreasuryYieldsParams {
+	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
+}
+
+func (p ListTreasuryYieldsParams) WithSort(q Sort) *ListTreasuryYieldsParams {
+	p.Sort = &q
+	return &p
+}
+
+func (p ListTreasuryYieldsParams) WithOrder(q Order) *ListTreasuryYieldsParams {
+	p.Order = &q
+	return &p
+}
+
+func (p ListTreasuryYieldsParams) WithLimit(q int) *ListTreasuryYieldsParams {
+	p.Limit = &q
+	return &p
+}
+
+// ListTreasuryYieldsResponse is the response returned by the ListTreasuryYields method.
+type ListTreasuryYieldsResponse struct {
+	BaseResponse
+
+	// An array of treasury yields that match your query.
+	Results []TreasuryYield `json:"results,omitempty"`
+}
+
+// TreasuryYield contains treasury yield data for a specific date.
+type TreasuryYield struct {
+	Date        string   `json:"date,omitempty"`
+	Yield1Month *float64 `json:"yield_1_month,omitempty"`
+	Yield3Month *float64 `json:"yield_3_month,omitempty"`
+	Yield6Month *float64 `json:"yield_6_month,omitempty"`
+	Yield1Year  *float64 `json:"yield_1_year,omitempty"`
+	Yield2Year  *float64 `json:"yield_2_year,omitempty"`
+	Yield3Year  *float64 `json:"yield_3_year,omitempty"`
+	Yield5Year  *float64 `json:"yield_5_year,omitempty"`
+	Yield7Year  *float64 `json:"yield_7_year,omitempty"`
+	Yield10Year *float64 `json:"yield_10_year,omitempty"`
+	Yield20Year *float64 `json:"yield_20_year,omitempty"`
+	Yield30Year *float64 `json:"yield_30_year,omitempty"`
+}