Wall St. Rank API Reference

API Reference

Introduction

The Wall St. Rank API gives you access to our extensive data set of fund manager holding, trading activity, portfolio details, trends and unique insights.

In addition to the endpoints and responses listed below, we also provide custom endpoints which contain more detailed responses, custom rankings and unique filtering tailored to our partners' unique data requirements.

If you don't find what you're looking for below, please get in touch and we'll give you access to a new custom endpoint tailored to your needs.

Getting Started

The Wall St. Rank API adheres to REST principles. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication and verbs.

Authentication

The Wall St. Rank API uses API keys for authentication. You can get your API key by contacting us.

You can use your API key as a bearer token in the Authorization requests header.

Alternatively, you can pass your API key in the api_key query parameter.

When possible, we recommend using the Authorization header method over the query parameter method.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Errors

We uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, the ticker is invalid, etc.). Codes in the 5xx range indicate an error with our servers (these are rare).

Stock

Fund Confidence

Retrieve fund manager confidence stats for the stock with the given ticker

Parameters

ticker

string

required

The ticker symbol of the stock

GET/v1/stocks/:ticker/fund-confidence

RESPONSE

      {
  "insights": [
    {
      "id": "funds-holding",
      "type": "change",
      "title": "Funds Holding the Stock",
      "year": 2024,
      "quarter": 1,
      "current_value": 4159,
      "previous_value": 3899,
      "change_percent": 6.67,
      "sentiment": "positive"
    },
    {
      "id": "funds-ownership",
      "type": "change",
      "title": "Funds Ownership",
      "year": 2024,
      "quarter": 1,
      "current_value": 63.01,
      "previous_value": 66.04,
      "change_percent": -3.03,
      "sentiment": "negative"
    },
    {
      "id": "funds-holding-in-top-10",
      "type": "change",
      "title": "Funds Holding in Top 10",
      "year": 2024,
      "quarter": 1,
      "current_value": 1477,
      "previous_value": 1048,
      "change_percent": 40.94,
      "sentiment": "positive"
    },
    {
      "id": "capital-invested",
      "type": "change",
      "title": "Capital Invested by Funds",
      "year": 2024,
      "quarter": 1,
      "current_value": 1413900616111,
      "previous_value": 807896158237,
      "change_percent": 75.01,
      "sentiment": "positive"
    },
    {
      "id": "net-new-positions",
      "type": "net",
      "title": "Net New Investments by Funds",
      "year": 2024,
      "quarter": 1,
      "new_positions": 451,
      "closed_positions": 191,
      "net_percent": 136.13,
      "sentiment": "positive"
    },
    {
      "id": "net-increased-positions",
      "type": "net",
      "title": "Net Increased Positions by Funds",
      "year": 2024,
      "quarter": 1,
      "increased_positions": 1575,
      "reduced_positions": 1918,
      "net_percent": -17.88,
      "sentiment": "negative"
    },
    {
      "id": "net-calls",
      "type": "net",
      "title": "Net Call Options by Funds",
      "year": 2024,
      "quarter": 1,
      "calls_value": 120124623000,
      "puts_value": 126155337000,
      "net_percent": -4.78,
      "sentiment": "neutral"
    }
  ]
}

Insider Confidence

Retrieve company insider confidence stats for the stock with the given ticker.

Parameters

ticker

string

required

The ticker symbol of the stock

Analyst Confidence

Retrieve analyst confidence stats for the stock with the given ticker.

Parameters

ticker

string

required

The ticker symbol of the stock

GET/v1/stocks/:ticker/analyst-confidence

RESPONSE

      {
  "ratings_3m": {
    "total": 11,
    "positive": 5,
    "positive_percent": 45.45,
    "neutral": 4,
    "neutral_percent": 36.36,
    "negative": 2,
    "negative_percent": 18.18,
    "high_target": {
      "price": 300,
      "percent": 20.94
    },
    "avg_target": {
      "price": 237.5382,
      "percent": -4.24
    },
    "low_target": {
      "price": 184,
      "percent": -25.82
    }
  }
}

News Confidence

Retrieve news confidence stats for the stock with the given ticker.

Parameters

ticker

string

required

The ticker symbol of the stock

GET/v1/stocks/:ticker/news-confidence

RESPONSE

      {
  "news_1d": {
    "total": 13,
    "positive": 4,
    "positive_percent": 30.77,
    "negative": 4,
    "negative_percent": 30.77,
    "neutral": 5,
    "neutral_percent": 38.46
  },
  "news_7d": {
    "total": 72,
    "positive": 46,
    "positive_percent": 63.89,
    "negative": 9,
    "negative_percent": 12.5,
    "neutral": 17,
    "neutral_percent": 23.61
  },
  "news_14d": {
    "total": 138,
    "positive": 94,
    "positive_percent": 68.12,
    "negative": 15,
    "negative_percent": 10.87,
    "neutral": 29,
    "neutral_percent": 21.01
  },
  "news_1m": {
    "total": 266,
    "positive": 146,
    "positive_percent": 54.89,
    "negative": 54,
    "negative_percent": 20.3,
    "neutral": 66,
    "neutral_percent": 24.81
  },
  "news_3m": {
    "total": 1013,
    "positive": 488,
    "positive_percent": 48.17,
    "negative": 242,
    "negative_percent": 23.89,
    "neutral": 283,
    "neutral_percent": 27.94
  },
  "news_6m": {
    "total": 2459,
    "positive": 1245,
    "positive_percent": 50.63,
    "negative": 578,
    "negative_percent": 23.51,
    "neutral": 636,
    "neutral_percent": 25.86
  }
}

Funds

Portfolios

Retrieve fund portfolios.

GET/v1/funds

RESPONSE

      {
  "portfolios": [
    {
      "id": "berkshire-hathaway",
      "name": "Berkshire Hathaway",
      "icon": "https://example.com/berkshire-hathaway.svg"
    },
    {
      "id": "blackrock",
      "name": "Blackrock",
      "icon": "https://example.com/blackrock.svg"
    },
    {
      "id": "invesco",
      "name": "Invesco",
      "icon": "https://example.com/invesco.svg"
    },
    {
      "id": "t-rowe-price",
      "name": "T. Rowe Price",
      "icon": "https://example.com/t-rowe-price.svg"
    }
  ]
}

Holdings

Retrieve the holdings of the given fund portfolio

Parameters

id

string

required

ID of the fund portfolio

GET/v1/funds/:id/holdings

RESPONSE

      {
  "holdings": [
    {
      "ticker": "MSFT",
      "market_value": 229789193000,
      "shares_change_percent": 1.31,
      "percent_of_portfolio": 5.34
    },
    {
      "ticker": "AAPL",
      "market_value": 178423293913,
      "shares_change_percent": -0.18,
      "percent_of_portfolio": 4.15
    },
    {
      "ticker": "NVDA",
      "market_value": 164423293913,
      "shares_change_percent": 1.43,
      "percent_of_portfolio": 3.83
    },
    {
      "ticker": "AMZN",
      "market_value": 115934932913,
      "shares_change_percent": 1.81,
      "percent_of_portfolio": 2.68
    }
  ]
}

Fund Trends

Funds Holding

Retrieve stocks ranked by the number of funds holding in the latest reporting quarter.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of current, change, change_percent.

Defaults to current.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

type

string

The type of security to retrieve.

One of stock, etf.

Returns all types if not specified.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

GET/v1/fund-trends/holding

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "reporting_year": 2024,
  "reporting_quarter": 3,
  "stocks": [
    {
      "ticker": "MSFT",
      "current": 5153,
      "previous": 5141,
      "change": 12,
      "change_percent": 0.23
    },
    {
      "ticker": "AAPL",
      "current": 4961,
      "previous": 5007,
      "change": -46,
      "change_percent": -0.92
    },
    {
      "ticker": "AMZN",
      "current": 4796,
      "previous": 4816,
      "change": -20,
      "change_percent": -0.42
    }
  ]
}

Funds Holding in Top 10

Retrieve stocks ranked by the number of funds holding the stock in their top 10 holdings in the latest reporting quarter.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of current, change, change_percent.

Defaults to current.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

type

string

The type of security to retrieve.

One of stock, etf.

Returns all types if not specified.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

GET/v1/fund-trends/holding-in-top-10

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "reporting_year": 2024,
  "reporting_quarter": 3,
  "stocks": [
    {
      "ticker": "AAPL",
      "current": 2949,
      "previous": 2959,
      "change": -10,
      "change_percent": -0.34
    },
    {
      "ticker": "MSFT",
      "current": 2801,
      "previous": 2966,
      "change": -165,
      "change_percent": -5.56
    },
    {
      "ticker": "NVDA",
      "current": 1735,
      "previous": 1766,
      "change": -31,
      "change_percent": -1.76
    }
  ]
}

Funds New Positions

Retrieve stocks ranked by the number of funds that opened a new position in the latest reporting quarter.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of current, change, change_percent.

Defaults to current.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

type

string

The type of security to retrieve.

One of stock, etf.

Returns all types if not specified.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

GET/v1/fund-trends/new-positions

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "reporting_year": 2024,
  "reporting_quarter": 3,
  "stocks": [
    {
      "ticker": "TSLA",
      "current": 366,
      "previous": 283,
      "change": 83,
      "change_percent": 29.33
    },
    {
      "ticker": "PLTR",
      "current": 318,
      "previous": 196,
      "change": 122,
      "change_percent": 62.24
    },
    {
      "ticker": "AVGO",
      "current": 315,
      "previous": 328,
      "change": -13,
      "change_percent": -3.96
    }
  ]
}

Funds Closed Positions

Retrieve stocks ranked by the number of funds that closed their existing position in the latest reporting quarter.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of current, change, change_percent.

Defaults to current.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

type

string

The type of security to retrieve.

One of stock, etf.

Returns all types if not specified.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

GET/v1/fund-trends/closed-positions

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "reporting_year": 2024,
  "reporting_quarter": 3,
  "stocks": [
    {
      "ticker": "INTC",
      "current": 453,
      "previous": 422,
      "change": 31,
      "change_percent": 7.35
    },
    {
      "ticker": "LRCX",
      "current": 447,
      "previous": 116,
      "change": 331,
      "change_percent": 285.34
    },
    {
      "ticker": "SMCI",
      "current": 428,
      "previous": 136,
      "change": 292,
      "change_percent": 214.71
    }
  ]
}

Funds Increased Positions

Retrieve stocks ranked by the number of funds that increased their existing position in the latest reporting quarter.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of current, change, change_percent.

Defaults to current.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

type

string

The type of security to retrieve.

One of stock, etf.

Returns all types if not specified.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

GET/v1/fund-trends/increased-positions

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "reporting_year": 2024,
  "reporting_quarter": 3,
  "stocks": [
    {
      "ticker": "META",
      "current": 1890,
      "previous": 1948,
      "change": -58,
      "change_percent": -2.98
    },
    {
      "ticker": "JPM",
      "current": 1688,
      "previous": 1697,
      "change": -9,
      "change_percent": -0.53
    },
    {
      "ticker": "XOM",
      "current": 1672,
      "previous": 2261,
      "change": -589,
      "change_percent": -26.05
    }
  ]
}

Funds Reduced Positions

Retrieve stocks ranked by the number of funds that reduced their existing position in the latest reporting quarter.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of current, change, change_percent.

Defaults to current.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

type

string

The type of security to retrieve.

One of stock, etf.

Returns all types if not specified.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

GET/v1/fund-trends/reduced-positions

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "reporting_year": 2024,
  "reporting_quarter": 3,
  "stocks": [
    {
      "ticker": "XOM",
      "current": 1579,
      "previous": 995,
      "change": 584,
      "change_percent": 58.69
    },
    {
      "ticker": "META",
      "current": 1515,
      "previous": 1374,
      "change": 141,
      "change_percent": 10.26
    },
    {
      "ticker": "PG",
      "current": 1497,
      "previous": 1524,
      "change": -27,
      "change_percent": -1.77
    }
  ]
}

Funds Calls

Retrieve stocks ranked by the total value of Call options bought by funds in the latest reporting quarter.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of current, change, change_percent.

Defaults to current.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

type

string

The type of security to retrieve.

One of stock, etf.

Returns all types if not specified.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

GET/v1/fund-trends/calls

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "reporting_year": 2024,
  "reporting_quarter": 3,
  "stocks": [
    {
      "ticker": "GLD",
      "current": 32237084000,
      "previous": 24122410000,
      "change": 8114674000,
      "change_percent": 33.64
    },
    {
      "ticker": "AMZN",
      "current": 26818069000,
      "previous": 32299995000,
      "change": -5481926000,
      "change_percent": -16.97
    },
    {
      "ticker": "EEM",
      "current": 17203043000,
      "previous": 12753292000,
      "change": 4449751000,
      "change_percent": 34.89
    }
  ]
}

Funds Puts

Retrieve stocks ranked by the total value of Put options bought by funds in the latest reporting quarter.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of current, change, change_percent.

Defaults to current.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

type

string

The type of security to retrieve.

One of stock, etf.

Returns all types if not specified.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

GET/v1/fund-trends/puts

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "reporting_year": 2024,
  "reporting_quarter": 3,
  "stocks": [
    {
      "ticker": "AVGO",
      "current": 17539431000,
      "previous": 20422591000,
      "change": -2883160000,
      "change_percent": -14.12
    },
    {
      "ticker": "NFLX",
      "current": 16225035000,
      "previous": 13762235000,
      "change": 2462800000,
      "change_percent": 17.9
    },
    {
      "ticker": "XLF",
      "current": 14512485000,
      "previous": 10729119000,
      "change": 3783366000,
      "change_percent": 35.26
    }
  ]
}

Funds Net New Positions

Retrieve stocks ranked by the net number of new positions opened by funds (new positions - closed positions) in the latest reporting quarter.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of net, new, closed.

Defaults to net.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

type

string

The type of security to retrieve.

One of stock, etf.

Returns all types if not specified.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

GET/v1/fund-trends/net-new-positions

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "reporting_year": 2024,
  "reporting_quarter": 3,
  "stocks": [
    {
      "ticker": "ETHE",
      "net_new_positions": 226,
      "new_positions": 232,
      "closed_positions": 6
    },
    {
      "ticker": "PLTR",
      "net_new_positions": 222,
      "new_positions": 318,
      "closed_positions": 96
    },
    {
      "ticker": "TLN",
      "net_new_positions": 217,
      "new_positions": 219,
      "closed_positions": 2
    }
  ]
}

Funds Net Closed Positions

Retrieve stocks ranked by the net number of positions closed by funds (closed positions - new positions) in the latest reporting quarter.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of net, new, closed.

Defaults to net.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

type

string

The type of security to retrieve.

One of stock, etf.

Returns all types if not specified.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

GET/v1/fund-trends/net-closed-positions

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "reporting_year": 2024,
  "reporting_quarter": 3,
  "stocks": [
    {
      "ticker": "DIS",
      "net_closed_positions": 104,
      "new_positions": 152,
      "closed_positions": 256
    },
    {
      "ticker": "TEL",
      "net_closed_positions": 103,
      "new_positions": 76,
      "closed_positions": 179
    },
    {
      "ticker": "FLG",
      "net_closed_positions": 91,
      "new_positions": 68,
      "closed_positions": 159
    }
  ]
}

Funds Net Increased Positions

Retrieve stocks ranked by the net number of positions increased by funds (increased positions - reduced positions) in the latest reporting quarter.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of net, increased, reduced.

Defaults to net.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

type

string

The type of security to retrieve.

One of stock, etf.

Returns all types if not specified.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

GET/v1/fund-trends/net-increased-positions

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "reporting_year": 2024,
  "reporting_quarter": 3,
  "stocks": [
    {
      "ticker": "MSTR",
      "net_increased_positions": 498,
      "increased_positions": 501,
      "reduced_positions": 3
    },
    {
      "ticker": "AMD",
      "net_increased_positions": 460,
      "increased_positions": 1218,
      "reduced_positions": 758
    },
    {
      "ticker": "NVDA",
      "net_increased_positions": 442,
      "increased_positions": 2239,
      "reduced_positions": 1797
    }
  ]
}

Funds Net Reduced Positions

Retrieve stocks ranked by the net number of positions reduced by funds (reduced positions - increased positions) in the latest reporting quarter.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of net, increased, reduced.

Defaults to net.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

type

string

The type of security to retrieve.

One of stock, etf.

Returns all types if not specified.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

GET/v1/fund-trends/net-reduced-positions

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "reporting_year": 2024,
  "reporting_quarter": 3,
  "stocks": [
    {
      "ticker": "SIRI",
      "net_reduced_positions": 182,
      "increased_positions": 64,
      "reduced_positions": 246
    },
    {
      "ticker": "USMV",
      "net_reduced_positions": 181,
      "increased_positions": 346,
      "reduced_positions": 527
    },
    {
      "ticker": "T",
      "net_reduced_positions": 172,
      "increased_positions": 902,
      "reduced_positions": 1074
    }
  ]
}

Funds Net Calls

Retrieve stocks ranked by the net amount of Call options bought by funds (calls bought - puts bought) in the latest reporting quarter.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of net, calls, puts.

Defaults to net.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

type

string

The type of security to retrieve.

One of stock, etf.

Returns all types if not specified.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

GET/v1/fund-trends/net-calls

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "reporting_year": 2024,
  "reporting_quarter": 3,
  "stocks": [
    {
      "ticker": "SLV",
      "net_calls": 3677739000,
      "calls": 6744772000,
      "puts": 3067033000
    },
    {
      "ticker": "KWEB",
      "net_calls": 1724397000,
      "calls": 3928346000,
      "puts": 2203949000
    },
    {
      "ticker": "JD",
      "net_calls": 1675912000,
      "calls": 3222099000,
      "puts": 1546187000
    }
  ]
}

Funds Net Puts

Retrieve stocks ranked by the net amount of Put options bought by funds (puts bought - calls bought) in the latest reporting quarter.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of net, calls, puts.

Defaults to net.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

type

string

The type of security to retrieve.

One of stock, etf.

Returns all types if not specified.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

GET/v1/fund-trends/net-puts

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "reporting_year": 2024,
  "reporting_quarter": 3,
  "stocks": [
    {
      "ticker": "GOOGL",
      "net_puts": 3645279000,
      "calls": 15161848000,
      "puts": 18807127000
    },
    {
      "ticker": "EFA",
      "net_puts": 3020280000,
      "calls": 6297150000,
      "puts": 9317430000
    },
    {
      "ticker": "ADBE",
      "net_puts": 2521331000,
      "calls": 5375762000,
      "puts": 7897093000
    }
  ]
}

Analysts

Analyst Firms

Retrieve analyst firms.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

min_ratings

number

The minimum number of ratings to filter by.

Defaults to 1.

GET/v1/analysts-firms

RESPONSE

      {
  "page": 5,
  "page_size": 100,
  "has_more_pages": true,
  "firms": [
    {
      "id": "URVZB16T",
      "name": "B of A Securities",
      "ratings_count": 7104
    },
    {
      "id": "tn46kYfi",
      "name": "B. Riley Securities",
      "ratings_count": 3094
    },
    {
      "id": "Er7OcorC",
      "name": "BMO Capital",
      "ratings_count": 4485
    }
  ]
}

Analyst Firm

Retrieve details of the firm with the given ID.

Parameters

id

string

required

The ID of the firm to retrieve.

Analysts

Retrieve analysts details.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

firm_id

string

The ID of the analyst firm to filter by.

Returns analysts from all firms if not specified.

min_ratings

number

The minimum number of ratings to filter by.

Defaults to 1.

GET/v1/analysts

RESPONSE

      {
  "page": 5,
  "page_size": 100,
  "has_more_pages": true,
  "analysts": [
    {
      "id": "of75Pzfu",
      "name": "Adrienne Yih",
      "ratings_count": 403,
      "firm": {
        "id": "KLlhfHBI",
        "name": "Barclays",
        "ratings_count": 11506
      }
    },
    {
      "id": "fmB1cCuf",
      "name": "Aleksey Yefremov",
      "ratings_count": 254,
      "firm": {
        "id": "AHzFuib5",
        "name": "Keybanc",
        "ratings_count": 5574
      }
    },
    {
      "id": "5i2uzRLI",
      "name": "Alex Henderson",
      "ratings_count": 386,
      "firm": {
        "id": "X1T4Bx3v",
        "name": "Needham",
        "ratings_count": 7758
      }
    }
  ]
}

Analyst

Retrieve details of the analyst with the given ID.

Parameters

id

string

required

The ID of the analyst to retrieve.

GET/v1/analysts/:id

RESPONSE

      {
  "id": "5i2uzRLI",
  "name": "Alex Henderson",
  "ratings_count": 386,
  "firm": {
    "id": "X1T4Bx3v",
    "name": "Needham",
    "ratings_count": 7758
  }
}

Analyst Ratings

Retrieve analyst ratings.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

tickers

string

One or more stock tickers separated by commas.

Returns rating for all tickers if not specified.

firm_id

string

The ID of the analyst firm to filter by.

Returns ratings from all firms if not specified.

analyst_id

string

The ID of the analyst to filter by.

Returns rating from all analysts if not specified.

GET/v1/analysts-ratings

RESPONSE

      {
  "page": 5,
  "page_size": 100,
  "has_more_pages": true,
  "ratings": [
    {
      "id": "KG6xf6Pd",
      "ticker": "CHEF",
      "rated_at": "2024-12-16T13:47:59Z",
      "action": "maintains",
      "action_price_target": "raises",
      "rating": "Buy",
      "sentiment": "positive",
      "price_target": 58,
      "adjusted_price_target": 58,
      "analyst": {
        "id": "4ho4A2Q2",
        "name": "Alexander Slagle",
        "ratings_count": 13,
        "firm": {
          "id": "aZ7iHP8v",
          "name": "Jefferies",
          "ratings_count": 4776
        }
      },
      "firm": {
        "id": "aZ7iHP8v",
        "name": "Jefferies",
        "ratings_count": 4776
      }
    },
    {
      "id": "baRI1xSI",
      "ticker": "USFD",
      "rated_at": "2024-12-16T13:41:40Z",
      "action": "maintains",
      "action_price_target": "raises",
      "rating": "Buy",
      "sentiment": "positive",
      "price_target": 82,
      "adjusted_price_target": 82,
      "analyst": {
        "id": "4ho4A2Q2",
        "name": "Alexander Slagle",
        "ratings_count": 13,
        "firm": {
          "id": "aZ7iHP8v",
          "name": "Jefferies",
          "ratings_count": 4776
        }
      },
      "firm": {
        "id": "aZ7iHP8v",
        "name": "Jefferies",
        "ratings_count": 4776
      }
    }
  ]
}

Analyst Trends

Analyst Upside

Retrieve stocks ranked by upside potential as determined by analyst price targets received in the last 3 months.

Parameters

page

number

The page number to retrieve.

Defaults to 1.

page_size

number

The number of items per page.

If specified, must be between 1 and 10000 inclusive.

Defaults to 100.

sort_by

string

The field to sort the results by.

One of upside_percent, bullish_percent, ratings_count.

Defaults to upside_percent.

sort_dir

string

The order to sort the results by.

One of asc, desc.

Defaults to desc.

market_cap

string

The market cap of securities to retrieve.

One or more of mega-cap, large-cap, mid-cap, small-cap, micro-cap, separated by commas.

Returns all market caps if not specified.

min_ratings_count

number

The minimum number of analyst ratings required for a stock in the result set.

Defaults to 3.

GET/v1/analyst-trends/upside

RESPONSE

      {
  "page": 1,
  "page_size": 100,
  "has_more_pages": true,
  "stocks": [
    {
      "ticker": "JD",
      "price_target": 48.67,
      "upside_percent": 32.57,
      "bullish_percent": 100,
      "ratings_count": 6
    },
    {
      "ticker": "NVDA",
      "price_target": 174.9,
      "upside_percent": 32.5,
      "bullish_percent": 93.1,
      "ratings_count": 29
    },
    {
      "ticker": "ACGL",
      "price_target": 120.89,
      "upside_percent": 32.35,
      "bullish_percent": 66.67,
      "ratings_count": 9
    }
  ]
}

News Trends

News Positivity

Retrieve stocks ranked by news positivity.

Parameters

period

string

The period used to calculate the news positivity.

One of 1-day, 7-day, 14-day, 1-month, 3-month, 6-month.

Defaults to 1-month.

min_articles

number

The minimum number of articles required within the above period for the stock to be returned in the result set.

Defaults to 3.

min_positive_percent

number

The minimum positive articles percent required within the above period for the stock to be returned in the result set.

Defaults to 0.

GET/v1/news-trends/positivity

RESPONSE

      {
  "stocks": [
    {
      "ticker": "NVDA",
      "num_articles": 879,
      "positive_percent": 80
    },
    {
      "ticker": "AAPL",
      "num_articles": 417,
      "positive_percent": 73
    },
    {
      "ticker": "AMZN",
      "num_articles": 582,
      "positive_percent": 72
    }
  ]
}

200	OK	Everything worked as expected.
400	Bad Request	The request was unacceptable, often due to missing a required parameter.
401	Unauthorized	No valid API key provided.
402	Request Failed	The parameters were valid but the request failed.
403	Forbidden	The API key doesn’t have permissions to perform the request.
404	Not Found	The requested resource doesn’t exist.
500, 502, 503, 504	Server Errors	Something went wrong on our end. (These are rare.)