oiricaud/oscars-model | API reference

Public

1 run

Run oiricaud/oscars-model with an API

Use one of our client libraries to get started quickly. Clicking on a library will take you to the Playground tab where you can tweak different inputs, see the results, and copy the corresponding code to use in your own project.

Input schema

The fields you can use to run this model with an API. If you don't give a value for a field its default value will be used.

Field	Type	Default value	Description
symbol	string	NVDA	Ticker symbol, 1-6 letters
direction	None	bullish	Flow direction
notional	number	2400000 Min: 1000 Max: 10000000000	Premium notional in USD
strike	number	200 Min: 0.5 Max: 100000	Strike price
expiry	string	2026-09-18	Expiry, e.g. 2026-09-18
contract	None	call	Contract type
headline	string	Someone paid up for September upside — " "and they were not patient about it.	One-line human read of the print (<=140 chars)
footer	string	your stop was hit	Brand line for the masthead

{
  "type": "object",
  "title": "Input",
  "properties": {
    "expiry": {
      "type": "string",
      "title": "Expiry",
      "default": "2026-09-18",
      "x-order": 4,
      "description": "Expiry, e.g. 2026-09-18"
    },
    "footer": {
      "type": "string",
      "title": "Footer",
      "default": "your stop was hit",
      "x-order": 7,
      "description": "Brand line for the masthead"
    },
    "strike": {
      "type": "number",
      "title": "Strike",
      "default": 200,
      "maximum": 100000,
      "minimum": 0.5,
      "x-order": 3,
      "description": "Strike price"
    },
    "symbol": {
      "type": "string",
      "title": "Symbol",
      "default": "NVDA",
      "x-order": 0,
      "description": "Ticker symbol, 1-6 letters"
    },
    "contract": {
      "enum": [
        "call",
        "put"
      ],
      "type": "string",
      "title": "contract",
      "description": "Contract type",
      "default": "call",
      "x-order": 5
    },
    "headline": {
      "type": "string",
      "title": "Headline",
      "default": "Someone paid up for September upside \u2014 \"\n                    \"and they were not patient about it.",
      "x-order": 6,
      "description": "One-line human read of the print (<=140 chars)"
    },
    "notional": {
      "type": "number",
      "title": "Notional",
      "default": 2400000,
      "maximum": 10000000000,
      "minimum": 1000,
      "x-order": 2,
      "description": "Premium notional in USD"
    },
    "direction": {
      "enum": [
        "bullish",
        "bearish"
      ],
      "type": "string",
      "title": "direction",
      "description": "Flow direction",
      "default": "bullish",
      "x-order": 1
    }
  }
}

Output schema

The shape of the response you’ll get when you run this model with an API.

Schema

{
  "type": "string",
  "title": "Output",
  "format": "uri"
}