data
OpenFIGI CLI for AI Agents
Use the OpenFIGI CLI from KosmoKrator to call OpenFIGI tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.OpenFIGI CLI Setup
OpenFIGI can be configured headlessly with `kosmokrator integrations:configure openfigi`.
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash
# Configure and verify this integration.
kosmokrator integrations:configure openfigi --enable --read allow --write ask --json
kosmokrator integrations:doctor openfigi --json
kosmokrator integrations:status --json Credentials
Authentication type: API key api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
api_key | OPENFIGI_API_KEY | Secret secret | no | API Key |
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call openfigi.openfigi_mapping '{}' --json kosmo integrations:openfigi openfigi_mapping '{}' --json Discovery
These commands return structured output for coding agents that need to inspect capabilities before choosing a function.
kosmo integrations:docs openfigi --json
kosmo integrations:docs openfigi.openfigi_mapping --json
kosmo integrations:schema openfigi.openfigi_mapping --json
kosmo integrations:search "OpenFIGI" --json
kosmo integrations:list --json Automation Contexts
The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.
CLI Functions
Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.
openfigi.openfigi_mapping
Map third-party identifiers to FIGIs.
read - Parameters
- none
kosmo integrations:call openfigi.openfigi_mapping '{}' --json kosmo integrations:openfigi openfigi_mapping '{}' --json openfigi.openfigi_mapping_values
List supported values for OpenFIGI mapping job properties.
read - Parameters
- none
kosmo integrations:call openfigi.openfigi_mapping_values '{}' --json kosmo integrations:openfigi openfigi_mapping_values '{}' --json openfigi.openfigi_search
Search for FIGIs using keywords and optional filters.
read - Parameters
- none
kosmo integrations:call openfigi.openfigi_search '{}' --json kosmo integrations:openfigi openfigi_search '{}' --json openfigi.openfigi_filter
Filter for FIGIs using OpenFIGI instrument filters.
read - Parameters
- none
kosmo integrations:call openfigi.openfigi_filter '{}' --json kosmo integrations:openfigi openfigi_filter '{}' --json openfigi.openfigi_schema
Retrieve the current OpenFIGI OpenAPI schema.
read - Parameters
- none
kosmo integrations:call openfigi.openfigi_schema '{}' --json kosmo integrations:openfigi openfigi_schema '{}' --json Function Schemas
Use these parameter tables when building CLI payloads without calling integrations:schema first.
openfigi.openfigi_mapping 0 parameters
kosmo integrations:schema openfigi.openfigi_mapping --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
openfigi.openfigi_mapping_values 0 parameters
kosmo integrations:schema openfigi.openfigi_mapping_values --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
openfigi.openfigi_search 0 parameters
kosmo integrations:schema openfigi.openfigi_search --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
openfigi.openfigi_filter 0 parameters
kosmo integrations:schema openfigi.openfigi_filter --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
openfigi.openfigi_schema 0 parameters
kosmo integrations:schema openfigi.openfigi_schema --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
Permissions
Headless calls still follow the integration read/write permission policy. Configure read/write defaults with
integrations:configure. Add --force only for trusted automation that should bypass that policy.