Simbad Tools#

Configuration File: simbad_tools.json Tool Type: Local Tools Count: 2

This page contains all tools defined in the simbad_tools.json configuration file.

Available Tools#

SIMBAD_advanced_query (Type: SIMBADAdvancedTool)#

Execute ADQL against SIMBAD TAP with explicit truncation detection. JSON requests use a MAXREC+1 …

SIMBAD_advanced_query tool specification

Tool Information:

  • Name: SIMBAD_advanced_query

  • Type: SIMBADAdvancedTool

  • Description: Execute ADQL against SIMBAD TAP with explicit truncation detection. JSON requests use a MAXREC+1 probe and return at most max_results rows; VOTable requests inspect QUERY_STATUS=OVERFLOW. metadata.has_more and result_set_complete prevent a MAXREC-limited response from appearing complete.

Parameters:

  • adql_query (string) (required) ADQL query string. Example: ‘SELECT TOP 10 main_id, ra, dec, otype FROM basic WHERE otype=’Star’ AND ra BETWEEN 0 AND 10’

  • max_results (integer) (optional) Maximum rows to return; overflow is reported in metadata

  • format (string) (optional) Output format. Options: ‘json’ or ‘votable’

Example Usage:

query = {
    "name": "SIMBAD_advanced_query",
    "arguments": {
        "adql_query": "example_value"
    }
}
result = tu.run(query)

SIMBAD_query_object (Type: SIMBADTool)#

Query SIMBAD by object name, coordinates, or wildcard identifier. Coordinate and identifier respo…

SIMBAD_query_object tool specification

Tool Information:

  • Name: SIMBAD_query_object

  • Type: SIMBADTool

  • Description: Query SIMBAD by object name, coordinates, or wildcard identifier. Coordinate and identifier responses are exactly paginated within the returned script response using offset/next_offset. SIMBAD script output has no upstream total or overflow flag, so metadata.upstream_result_set_complete is null; use SIMBAD_advanced_query when broad-query overflow detection is required. Script errors retain the upstream message instead of being mislabeled as ‘object not found’.

Parameters:

  • query_type (string) (optional) Type of query to perform. Options: ‘object_name’ (search by name), ‘coordinates’ (search by position), ‘identifier’ (search by identifier pattern)

  • object_name (string) (optional) Name of the astronomical object (e.g., ‘M31’, ‘Sirius’, ‘NGC 1068’). Required when query_type=’object_name’

  • ra (number) (optional) Right Ascension in degrees (0-360). Required when query_type=’coordinates’

  • dec (number) (optional) Declination in degrees (-90 to +90). Required when query_type=’coordinates’

  • radius (number) (optional) Search radius in arcminutes for coordinate queries. Default is 1.0 arcmin

  • identifier (string) (optional) Identifier pattern with wildcards (e.g., ‘HD ‘, ‘NGC 10’). Required when query_type=’identifier’

  • output_format (string) (optional) Level of detail in output. Options: ‘basic’ (ID, coordinates, type), ‘detailed’ (includes spectral type and flux), ‘full’ (all available data)

  • max_results (integer) (optional) Maximum rows on this local response page

  • offset (integer) (optional) Zero-based offset into the rows returned by the SIMBAD script response; continue with metadata.next_offset

Example Usage:

query = {
    "name": "SIMBAD_query_object",
    "arguments": {
    }
}
result = tu.run(query)