{"openapi":"3.1.0","info":{"title":"Extra Space Storage API (Bowmark)","version":"e833508f87ff","description":"Extra Space Storage — self-storage facility search and detail. `search` takes a US city or ZIP and returns the nearby facilities its own locator would, nearest first, each with its address, distance, amenities and the real monthly price of the cheapest unit in every size it carries. `getFacility` reads one of them in full: street address, both phone lines, office and gate-access hours, what its units offer, starting prices, rating, driving directions and the nearby facilities. `checkAvailability` checks one specific unit size at one facility and returns every unit class that matches it, each with its own live availability and price. Published deals are declared but not built yet.\n\nEvery function Bowmark has for Extra Space Storage (extraspace.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/extraspace/search":{"post":{"operationId":"search","summary":"Searches Extra Space Storage's live facility inventory the way its own homepage locator does.","description":"Searches Extra Space Storage's live facility inventory the way its own homepage locator does. `query` is a US city (\"Austin, TX\", \"Austin\" and \"Austin TX\" all work) or a ZIP (\"90210\"); a full street address is NOT supported by this surface and throws a caller-fixable error saying so. Returns the facilities nearest first, each with its street address, distance in miles, phone, amenities, review rating, and the real monthly web price of the cheapest unit in every size class it carries — plus the struck-through \"street\" rate and any move-in offer (\"2nd Month Free\") per size. Narrow with `climateControlled`, `driveUp`, `vehicleStorage`, `unitSize` (\"10x10\") or `limit`; `totalFound` always reports the unclipped count so a `limit` is never a silent truncation. A price of `null` means the facility does not carry that size — the site sends 0 and this never forwards it as a free unit. A real place Extra Space simply does not serve (Juneau AK) returns zero facilities and no error; a term it cannot place at all throws instead, because \"nothing near you\" and \"I could not read that\" are opposite answers.\n\nCalls `bowmark.providers.extraspace.search`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ExtraspaceSearchResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"},"options":{"$ref":"#/components/schemas/ExtraspaceSearchOptions","description":"TypeScript: `ExtraspaceSearchOptions`"}},"required":["query"],"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/extraspace/getFacility":{"post":{"operationId":"getFacility","summary":"Reads ONE Extra Space Storage facility in full — everything its own facility page is built from, in one call.","description":"Reads ONE Extra Space Storage facility in full — everything its own facility page is built from, in one call. `storeId` is the `storeId` `search` returns (e.g. 300125), as a number or a string, or a facility URL ending in one; the short facility NUMBER in the display name (1016) is a different key and is refused rather than guessed at. Returns the full street address, both phone lines (the number for new customers and the direct-dial one for existing ones), the local time zone, the on-site manager, the site's own description of the facility — which is the only place it states security features like video surveillance and electronic gate access, so it is returned as written rather than pattern-matched into booleans — `officeHours` and `gateHours` as published weekly schedules plus every other schedule it publishes, access flags (24-hour, extended hours, kiosk, vehicle parking), what its currently-listed units offer as `{code, display}` pairs (match on the stable `code`, e.g. \"DriveUpAccess\" — `display` is presentation copy the site can reword), starting price per size class, review rating and count, driving directions per approach, a maps link, image URLs, and the nearby Extra Space facilities the same response volunteers. A facility that is announced but not renting yet returns its address, phones and hours with `isComingSoon: true`, all prices `null` and `unitFeatures` empty. An id that is not a facility throws a caller-fixable error rather than returning an empty-looking result.\n\nCalls `bowmark.providers.extraspace.getFacility`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ExtraspaceFacilityDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"storeId":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"TypeScript: `number | string`"}},"required":["storeId"],"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/extraspace/checkAvailability":{"post":{"operationId":"checkAvailability","summary":"Checks current availability and price for one unit SIZE (e.g.","description":"Checks current availability and price for one unit SIZE (e.g. \"10x10\", \"5x15\" — width x depth, in feet) at one Extra Space Storage facility. `storeId` is the same id `search`/`getFacility` take. Returns every unit CLASS at that facility whose dimensions match the requested size — a facility routinely lists more than one class of the same nominal size (a live capture of facility 300125 carries four separate `10' x 10'` classes with different availability), so this never collapses them to one \"best\" answer the way `search`'s roll-up does. Each match reports whether the site is CURRENTLY offering it (`available`), how many units of that class are free (`unitsAvailable`), both the struck-through \"street\" rate and the real \"web\" rate, any active move-in promotion, and the class's own features. An empty `matches` array means the facility does not carry that size at all — a coming-soon facility with zero listed unit classes returns `matches: []` for any size, with no error, exactly like a fully-open facility that simply does not offer it. `unitSize` outside `width x depth` form (e.g. \"12x40\", which nothing in this fixture carries) is not refused as invalid — it is a value the site may or may not stock, so it is looked up and answered with an empty array like any other size the facility does not have; only a string that cannot be PARSED as `<number>x<number>` is a caller error.\n\nCalls `bowmark.providers.extraspace.checkAvailability`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ExtraspaceAvailabilityResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"storeId":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"TypeScript: `number | string`"},"unitSize":{"type":"string","description":"TypeScript: `string`"}},"required":["storeId","unitSize"],"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}}},"ExtraspaceSearchOptions":{"type":"object","properties":{"climateControlled":{"type":"boolean"},"driveUp":{"type":"boolean"},"vehicleStorage":{"type":"boolean"},"unitSize":{"type":"string"},"limit":{"type":"number"}},"additionalProperties":true}}}}