{"openapi":"3.1.0","info":{"title":"xcstrings search API","version":"1.0.0","description":"Search localized strings from Apple system applications and frameworks."},"servers":[{"url":"https://xcstrings.com"}],"externalDocs":{"description":"xcstrings agent and API instructions","url":"https://xcstrings.com/llms.txt"},"paths":{"/api/search":{"get":{"operationId":"searchAppleLocalizationStrings","summary":"Search Apple system strings","description":"Find strings from Apple system applications and frameworks. Short interface terms such as Cancel, Done, and Settings produce the most useful results.","parameters":[{"name":"term","in":"query","required":true,"description":"A short string to search for.","schema":{"type":"string","minLength":1}},{"name":"locales","in":"query","description":"Comma-separated locale codes, such as en,de.","schema":{"type":"string"}},{"name":"platform","in":"query","description":"Limit matches to one Apple platform.","schema":{"type":"string","enum":["ios","macos","watchos","tvos","visionos"]}},{"name":"offset","in":"query","description":"Number of matching records to skip.","schema":{"type":"integer","minimum":0}},{"name":"limit","in":"query","description":"Maximum number of matching records to return.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"includeBundles","in":"query","description":"Include matching Apple bundle identifiers in each result.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Matching strings and pagination metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"400":{"description":"Invalid search parameters.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"405":{"description":"The endpoint only accepts GET requests.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"The search service could not complete the request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"ProblemDetails":{"type":"object","description":"An RFC 9457 problem response with a stable xcstrings error code and recovery hint.","required":["type","title","status","detail","instance","code","hint"],"properties":{"type":{"type":"string","format":"uri-reference"},"title":{"type":"string"},"status":{"type":"integer","minimum":400,"maximum":599},"detail":{"type":"string"},"instance":{"type":"string","format":"uri-reference"},"code":{"type":"string"},"hint":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"SearchResponse":{"type":"object","required":["results","metadata"],"properties":{"results":{"type":"array","items":{"type":"object","required":["joinedKeyId","translations"],"properties":{"joinedKeyId":{"type":"integer"},"bundles":{"type":"array","items":{"type":"object","required":["bundleIdentifier","platform"],"properties":{"bundleIdentifier":{"type":"string"},"platform":{"type":"string","enum":["ios","macos","watchos","tvos","visionos"]}}}},"translations":{"type":"array","items":{"type":"object","required":["locale","translation"],"properties":{"locale":{"type":"string"},"translation":{"type":"string"}}}}}}},"metadata":{"type":"object","required":["total","offset","limit","hasMore"],"properties":{"total":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}}}}