View as Markdown
Mboum icon

Mboum ACTION

Get Stock Screener Results

Screen stocks based on various financial criteria and filters. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mboum account once, then configure and run Get Stock Screener Results from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "mboum-get-screener",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mboum: { authProvisionId: "apn_xxxxxxx" },
    metricType: "Metric Type",
    filter: "Filter",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Stock Screener Results inputs
Property Type Description
metricType Metric Type string
Type of metric to use for screening
Required
filter Filter string
Filter to apply to the screener. See the documentation for more information about screeners
Required
page Page integer
Page number to return
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
mboum-get-screener
Version
0.0.2
App
Mboum
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes