All vocabularies
All controlled vocabularies in one download
GET
/openapi/v3/reference/vocabRefresh: Minute / daily
This endpoint uses v3 at https://openapi.sosovalue.com/openapi/v3. Do not append it to /openapi/v1; see version-specific conventions.
Enum fields in business responses always return codes (e.g. market_status: "AFTER_HOURS", action_type, sector). Fetch display names from here — do not hardcode them in your client: when we add enum values, hardcoded clients render blanks.
| Endpoint | Returns | Purpose |
|---|---|---|
| /reference/vocab | data.vocab = { namespace: { code: label } } + data.enums + data.count | Avoids per-category requests — covers all controlled vocabularies. Recommended: fetch once at cold start |
| /reference/enums | data.enums = { field: { code: label } } | Business enums only (market_status / action_type / statement, etc.) |
| /reference/{dict} | Array | A single vocabulary |
Valid {dict} Values
product-types (values for the type parameter) · price-types · asset-types · venues · currencies · concepts (financial-statement accounting concepts) · metrics (metric codes + units + applicable layer). Anything else → 400401.
Request Example
curl "https://openapi.sosovalue.com/openapi/v3/reference/vocab" \ -H "x-soso-api-key: $SOSO_API_KEY"
Notes
- Sector / industry display names do not go through
{dict}: the code→label mappings forsector/industry/ GICS live in the corresponding namespaces of/reference/vocab(included in the single full download) — there is no standalonesectorsvocabulary endpoint. - All three support
?lang=(defaulten; Simplified Chinese:zh). Missing translations fall back to English per field — no fields are dropped — andmeta.langechoes the language actually in effect. - Vocabularies are small, stable sets: returned as plain arrays/objects, unpaginated, currently cached for 5 minutes. Honor the response
Cache-Controlheader rather than hardcoding that TTL.