{"openapi":"3.1.0","info":{"title":"California Lottery API (Bowmark)","version":"e833508f87ff","description":"California Lottery: winning numbers and prizes for Powerball, Mega Millions, SuperLotto Plus, Fantasy 5 and Daily games, check your numbers against past draws, Scratchers games, site search and retailers near a point.\n\nEvery function Bowmark has for California Lottery (calottery.com) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/calottery/draws":{"post":{"operationId":"draws","summary":"Reads California Lottery winning numbers and prize payouts for a draw game (most recent first), plus the next draw's date and estimated jackpot.","description":"Reads California Lottery winning numbers and prize payouts for a draw game (most recent first), plus the next draw's date and estimated jackpot. game is \"powerball\", \"megamillions\", \"superlotto\", \"fantasy5\", \"daily3\", \"daily4\" or \"dailyderby\".\n\nCalls `bowmark.providers.calottery.draws`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CalotteryDrawResults>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CalotteryDrawsArgs","description":"TypeScript: `CalotteryDrawsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/calottery/checkNumbers":{"post":{"operationId":"checkNumbers","summary":"Checks five picked numbers (and a Powerball/Mega/bonus number) against every past California Lottery draw of a game, returning the draws where they hit and which numbers matched.","description":"Checks five picked numbers (and a Powerball/Mega/bonus number) against every past California Lottery draw of a game, returning the draws where they hit and which numbers matched. since is an optional MM/DD/YYYY lower bound.\n\nCalls `bowmark.providers.calottery.checkNumbers`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CalotteryMatchedDraw[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CalotteryCheckNumbersArgs","description":"TypeScript: `CalotteryCheckNumbersArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/calottery/scratchers":{"post":{"operationId":"scratchers","summary":"Lists California Lottery Scratchers games with ticket price, top prize, overall odds and launch date; filter by name or game number, price, game type or show (\"Hot Sellers\", \"Newest Games\").","description":"Lists California Lottery Scratchers games with ticket price, top prize, overall odds and launch date; filter by name or game number, price, game type or show (\"Hot Sellers\", \"Newest Games\").\n\nCalls `bowmark.providers.calottery.scratchers`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CalotteryScratchers>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CalotteryScratchersArgs","description":"TypeScript: `CalotteryScratchersArgs`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/calottery/search":{"post":{"operationId":"search","summary":"Searches calottery.com's pages and documents (games, press releases, FAQs, PDFs), returning titles and URLs.","description":"Searches calottery.com's pages and documents (games, press releases, FAQs, PDFs), returning titles and URLs.\n\nCalls `bowmark.providers.calottery.search`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CalotterySearch>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CalotterySearchArgs","description":"TypeScript: `CalotterySearchArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/calottery/retailers":{"post":{"operationId":"retailers","summary":"Finds California Lottery retailers near a latitude/longitude, nearest first, with address and whether they sell all games, Hot Spot, or only Scratchers.","description":"Finds California Lottery retailers near a latitude/longitude, nearest first, with address and whether they sell all games, Hot Spot, or only Scratchers.\n\nCalls `bowmark.providers.calottery.retailers`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CalotteryRetailer[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CalotteryRetailersArgs","description":"TypeScript: `CalotteryRetailersArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}},"CalotteryCheckNumbersArgs":{"type":"object","properties":{"game":{"anyOf":[{"const":"powerball"},{"const":"megamillions"},{"const":"superlotto"},{"const":"fantasy5"},{"type":"number"}]},"numbers":{"type":"array","items":{"type":"number"}},"bonus":{"type":"number"},"since":{"type":"string"}},"required":["game","numbers"],"additionalProperties":true},"CalotteryDrawsArgs":{"type":"object","properties":{"game":{"$ref":"#/components/schemas/CalotteryGame"},"page":{"type":"number"},"size":{"type":"number"}},"required":["game"],"additionalProperties":true},"CalotteryGame":{"anyOf":[{"const":"powerball"},{"const":"megamillions"},{"const":"superlotto"},{"const":"fantasy5"},{"const":"daily3"},{"const":"daily4"},{"const":"dailyderby"},{"type":"number"}]},"CalotteryRetailersArgs":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"limit":{"type":"number"}},"required":["latitude","longitude"],"additionalProperties":true},"CalotteryScratchersArgs":{"type":"object","properties":{"query":{"type":"string"},"price":{"type":"number"},"gameType":{"type":"string"},"show":{"type":"string"},"sort":{"type":"string"},"page":{"type":"number"},"size":{"type":"number"}},"additionalProperties":true},"CalotterySearchArgs":{"type":"object","properties":{"query":{"type":"string"},"limit":{"type":"number"},"offset":{"type":"number"}},"required":["query"],"additionalProperties":true}}}}