search_library
Search the public record
Find public-records sources (datasets, portals, registers, reports) by question or keywords. Use `place` to include everything covering a place, from the city up to federal and global sources. Returns the publisher, how to get the data (API endpoint or page), update rate, last update, licence and whether we verified it. Not for finding, profiling or screening people.
输入参数limitplacequery必填department
Full details of one source by id: publisher, original link, API endpoint, formats, update rate, last update, licence, location detail, check status and notes.
输入参数id必填
The atlas: world, countries, states, counties and cities, with their ids. Filter by parent id (e.g. 'us' for US states) or kind.
输入参数kindnameparent
list_departments
List shelves
The 15 departments (shelves) every source sits on, with what each covers.
无需输入参数。
Records people need that the library doesn't hold yet, or that no agency publishes. Check this before telling a user a record doesn't exist.
输入参数placestatus
search_records
Search the records themselves
The records SOS.city reads from agencies' open data, one row each: building permits, code-enforcement cases, inspections, certificates of occupancy, new business registrations, grants, weather alerts, earthquakes, US wildfires (NIFC) and SCE power shutoffs. Filter by place, kind, ZIP or street address. Each row links to the agency's original. History depends on the plan (Free: 30 days, 100 rows). full_history=true (1 credit) and limit over 100 (1 credit per extra 100 rows, up to 1,000) are paid from the API key's credits; see get_store.
输入参数zipkindlimitplacesinceaddressfull_history
request_record
Request a record
Ask SOS.city to find a public record that isn't in the library. It joins the gap board; give an email to hear back. Never for locating or profiling a person.
输入参数emailplacequestion必填
get_store
See prices and how to pay
The SOS.city data store: what's free, what costs credits (1 credit = 1 cent), credit packs, city data packs, building records and deep searches, and every way to pay (credits with an API key, x402 USDC, or a Stripe link for a person). Shows the caller's credit balance when an API key is sent.
无需输入参数。
buy
Buy credits or a city data pack
Starts a one-time purchase and returns a Stripe Checkout link for the person who pays, plus a status_url to poll. product: credits_1k ($10), credits_10k ($79) or city_pack ($29, needs place). The person must agree to the data-use terms (no screening or profiling people): pass agree_data_use=true only after they have.
输入参数email必填placeproduct必填personhoodagree_data_use必填
get_city_pack
Get a city data pack
Every source that covers one place (with publisher, original link, licence and reuse terms) plus a year of records whose sources allow reuse. Costs 2900 credits from the API key's balance. Without credits, use buy (product city_pack) or the REST URL with x402.
输入参数place必填