--- title: "POST /udl/starcatalog" method: POST path: "/udl/starcatalog" tags: ["Star Catalog"] --- # POST /udl/starcatalog `POST /udl/starcatalog` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/starcatalog` - Auth: none declared Service operation to take a single StarCatalog record as a POST body and ingest into the database. A specific role is required to perform this service operation. Please contact the UDL team for assistance. ## Request body - StarCatalogIngest: The star catalog provides the position, proper motion, parallax, and photometric magnitudes at various bandpasses of a star. - `id` string: Unique identifier of the record, auto-generated by the system. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `csId` integer, required: The ID of this object in the specific catalog associated with this record. This field will either contain the value in the gncCatId or sdaCatId field. - `gncCatId` integer: The ID of this object in the Guidance and Navigation Control (GNC) Catalog. If this field is populated it shall match the csId field. - `sdaCatId` integer: The ID of this object in the Space Domain Awareness (SDA) Catalog. If this field is populated it shall match the csId field. - `gaiadr3CatId` integer: The source ID of this object in the Gaia DR3 Catalog (GA). - `hipCatId` integer: The HIP ID of this object in the Hipparcos Catalog (HI). - `twoMASSId` string: The designation of this object in the Two Micron All Sky Survey (2MASS) Point Source Catalog (TP). - `allWISEId` string: The designation of this object in the All Wide-field Infrared Survey Explorer (AllWISE) catalog (AL). - `panStarrsId` integer: The Panoramic Survey Telescope and Rapid Response System (Pan-STARRS) (PS) object ID. - `ukidssLASId` integer: The United Kingdom Infrared Deep Sky Survey (UKIDSS) Large Area Survey (LAS) (UL) source ID of this object. - `vhsId` integer: The Visible and Infrared Survey Telescope for Astronomy (VISTA) Hemisphere Survey (VHS) (VS) source ID of this object. - `aavsoVsxId` integer: The American Association of Variable Star Observers (AAVSO) Variable Star Index (VSX) (VX) object ID of this object. - `tychoDscId` integer: The Tycho Double Star Catalog (TD) identifier (specified as Tycho-2 ID) of this object. - `twoMassXscId` string: The Two Micron All Sky Survey (2MASS) Extended Source Catalog (XSC) (TX) designation of this object. - `ukidssGPSId` integer: The United Kingdom Infrared Deep Sky Survey (UKIDSS) Galactic Plane Survey (GPS) (UP) source ID of this object. - `wdsCatId` string: The Washington Double Star Catalog (WD) identifier of this object. - `carrascoCatId` integer: The Carrasco catalog (CR) identifier of this object. - `ducatiCatId` string: The Ducati catalog (DU) name of this object. - `apassId` string: The American Association of Variable Star Observers (AAVSO) Photometric All-Sky Survey (APASS) (AP) name of this object. - `skyMapperId` integer: The SkyMapper (SK) catalog object ID. - `uhsId` integer: The United Kingdom Infrared Telescope (UKIRT) Hemispheric Survey (UHS) (UH) source ID of this object. - `catWise2020Id` string: The CatWISE2020 (CA) catalog source ID of this object. - `ukidssGCSId` integer: The United Kingdom Infrared Deep Sky Survey (UKIDSS) Galactic Clusters Survey (GCS) (UC) source ID of this object. - `healpixIndex` integer: The Healpix index. Consumers should contact the provider for details on the indexing scheme. - `catVersion` string: The version of the catalog associated with this object. - `ra` number, double, required: Barycentric right ascension of the source in the International Celestial Reference System (ICRS) frame at the reference epoch, in degrees. - `raUnc` number, double: Uncertainty of the right ascension of the source, in milliarcseconds, at the reference epoch. - `dec` number, double, required: Barycentric declination of the source in International Celestial Reference System (ICRS) at the reference epoch, in degrees. - `decUnc` number, double: Uncertainty of the declination of the source, in milliarcseconds, at the reference epoch. - `posUncFlag` boolean: Flag indicating that the position uncertainty in either ra or dec is greater than 100 milliarcseconds. - `parallax` number, double: Absolute stellar parallax of the source, in milliarcseconds. - `parallaxUnc` number, double: Uncertainty of the stellar parallax, in milliarcseconds. - `pmra` number, double: Proper motion in right ascension of the source, in milliarcseconds per year, at the reference epoch. - `pmraUnc` number, double: Uncertainty of proper motion in right ascension, in milliarcseconds per year. - `pmdec` number, double: Proper motion in declination of the source, in milliarcseconds per year, at the reference epoch. - `pmdecUnc` number, double: Uncertainty of proper motion in declination, in milliarcseconds per year. - `pmUncFlag` boolean: Flag indicating that the proper motion uncertainty in either ra or dec is greater than 10 milliarcseconds per year. - `astrometryOrigin` string, required: Originating astrometric catalog for this object (GA (GAIA), HI (HIPPARCOS), UB (USNOBSC), AL, AP, CA, CR, DU, FK6_I, FK6_III, PS, SK, TD, TP, TX, UC, UL, UH, UP, VH, VS, WD). - `starEpoch` number, double, required: Reference epoch to which the astrometric source parameters are referred, expressed as Julian Year in Barycentric Coordinate Time (TCB). - `gmag` number, double: Gaia optical photometric G-band in the Vega scale measured in magnitudes. - `gmagUnc` number, double: Gaia optical photometric G-band uncertainty in the Vega scale measured in magnitudes. - `bpmag` number, double: Gaia optical photometric Bp-band in the Vega scale measured in magnitudes. - `bpmagUnc` number, double: Gaia optical Bp-band uncertainty in the Vega scale measured in magnitudes. - `rpmag` number, double: Gaia optical Rp-band in the Vega scale measured in magnitudes. - `rpmagUnc` number, double: Gaia optical photometric Rp-band uncertainty in the Vega scale measured in magnitudes. - `sgmag` number, double: Original G magnitude if the source is in Gaia, otherwise the magnitude is converted from other photometric passbands, when possible, measured in magnitudes. - `sgmagUnc` number, double: Uncertainty of sgmag measured in magnitudes. - `bmag` number, double: Optical Johnson B magnitude measured in magnitudes. - `bmagUnc` number, double: Uncertainty of optical Johnson B magnitude measured in magnitudes. - `bmagOrigin` string: Catalog of origin of optical Johnson B magnitude (AP, CR, HI). - `vmag` number, double: Optical Johnson V magnitude measured in magnitudes. - `vmagUnc` number, double: Uncertainty of the Optical Johnson V magnitude measured in magnitudes. - `vmagOrigin` string: Catalog of origin of Optical Johnson V magnitude (AP, CR, DU, GA, HI). - `rmag` number, double: Optical Johnson R magnitude measured in magnitudes. - `rmagUnc` number, double: Uncertainty of the Optical Johnson R magnitude measured in magnitudes. - `rmagOrigin` string: Catalog of origin of the Optical Johnson R magnitude (CR, GA). - `imag` number, double: Optical Johnson I magnitude measured in magnitudes. - `imagUnc` number, double: Uncertainty of optical Johnson I magnitude measured in magnitudes. - `imagOrigin` string: Catalog of origin of optical Johnson I magnitude (CR, GA, HI). - `abgmag` number, double: Optical AB g magnitude. - `abgmagUnc` number, double: Uncertainty of optical AB g magnitude. - `abgmagOrigin` string: Catalog of origin of optical AB g magnitude. - `abrmag` number, double: Optical AB r magnitude. - `abrmagUnc` number, double: Uncertainty of optical AB r magnitude. - `abrmagOrigin` string: Catalog of origin of optical AB r magnitude. - `abimag` number, double: Optical AB i magnitude. - `abimagUnc` number, double: Uncertainty of optical AB i magnitude. - `abimagOrigin` string: Catalog of origin of optical AB i magnitude. - `abzmag` number, double: Optical AB z magnitude. - `abzmagUnc` number, double: Uncertainty of optical AB z magnitude. - `abzmagOrigin` string: Catalog of origin of optical AB z magnitude. - `abymag` number, double: Optical AB y magnitude. - `abymagUnc` number, double: Uncertainty of optical AB y magnitude. - `abymagOrigin` string: Catalog of origin of optical AB y magnitude. - `jmag` number, double: Near-infrared photometric J-band magnitude in the Vega scale measured in magnitudes. - `jmagUnc` number, double: Near-infrared photometric J-band magnitude uncertainty in the Vega scale measured in magnitudes. - `jmagOrigin` string: Near-infrared photometric J-band catalog of origin in the Vega scale (TP, UH, UL, UP, VH). - `kmag` number, double: Near-infrared photometric K-band magnitude in the Vega scale measured in magnitudes. - `kmagUnc` number, double: Near-infrared photometric K-band magnitude uncertainty in the Vega scale measured in magnitudes. - `kmagOrigin` string: Near-infrared photometric K-band catalog of origin in the Vega scale (TP, UC, UH, UL, UP, VH). - `hmag` number, double: Near-infrared photometric H-band magnitude in the Vega scale measured in magnitudes. - `hmagUnc` number, double: Near-infrared photometric H-band magnitude uncertainty in the Vega scale measured in magnitudes. - `hmagOrigin` string: Near-infrared photometric H-band catalog of origin in the Vega scale (TP, UC, UL, UP, VH). - `w1mag` number, double: Mid-infrared photometric W1-band (3.4 microns) magnitude in the Vega system measured in magnitudes. - `w1magUnc` number, double: Mid-infrared photometric W1-band (3.4 microns) magnitude uncertainty in the Vega system measured in magnitudes. - `w1sat` number, double: Mid-infrared photometric W1-band (3.4 microns) saturated pixel fraction in the Vega system. - `w1magOrigin` string: Mid-infrared photometric W1-band (3.4 microns) catalog of origin in the Vega system (AL, CA). - `w2mag` number, double: Mid-infrared photometric W2-band (4.6 microns) magnitude in the Vega system measured in magnitudes. - `w2magUnc` number, double: Mid-infrared photometric W2-band (4.6 microns) magnitude uncertainty in the Vega system measured in magnitudes. - `w2sat` number, double: Mid-infrared photometric W2-band (4.6 microns) saturated pixel fraction in the Vega system. - `w2magOrigin` string: Mid-infrared photometric W2-band (4.6 microns) catalog of origin in the Vega system (AL, CA). - `w3mag` number, double: Mid-infrared photometric W3-band (12 microns) magnitude in the Vega system measured in magnitudes. - `w3magUnc` number, double: Mid-infrared photometric W3-band (12 microns) magnitude uncertainty in the Vega system measured in magnitudes. - `w3sat` number, double: Mid-infrared photometric W3-band (12 microns) saturated pixel fraction in the Vega system. - `w3magOrigin` string: Mid-infrared photometric W3-band (12 microns) catalog of origin in the Vega system (AL). - `w4mag` number, double: Mid-infrared photometric W4-band (22 microns) magnitude in the Vega system measured in magnitudes. - `w4magUnc` number, double: Mid-infrared photometric W4-band (22 microns) magnitude uncertainty in the Vega system measured in magnitudes. - `w4sat` number, double: Mid-infrared photometric W4-band (22 microns) saturated pixel fraction in the Vega system. - `w4magOrigin` string: Mid-infrared photometric W4-band (22 microns) catalog of origin in the Vega system (AL). - `allWISEnaInd` integer: Active deblending indicator in AllWISE. - `allWISEccInd` string: Contamination and confusion indicator in AllWISE. - `allWISEphQualInd` string: Photometric quality indicator in AllWISE. - `ps1ObjInfoFlag` integer: Object information flag in Pan-STARRS. - `ps1QualityFlag` integer: Quality flag in Pan-STARRS. - `ps1astrometryCorrectionFlag` integer: Astrometry correction flag in Pan-STARRS. - `twoMassPHQualInd` string: Photometric (PH) quality indicator in 2MASS PSC. - `twoMassReadFlag` string: Read flag in 2MASS PSC. - `astrometricExcessNoise` number, double: Astrometric excess noise in the Gaia catalog measured in milliarcseconds. - `astrometricExcessNoiseSig` number, double: Astrometric excess noise sigma in Gaia. - `ruwe` number, double: RUWE in Gaia. - `nonSingleStar` string: Identifier indicating the source is a non-single star in gaia (additional information is available in non-single star tables. Consumers should contact the provider for details on the specifications). - `varFlag` boolean: Flag indicating that the source exhibits variable magnitude. - `variability` string: Identifier indicating variability is present in the photometric data. Consumers should contact the provider for details on the specifications. - `multFlag` boolean: Flag indicating that this is a multiple object source. - `multiplicity` string: Identifier indicating multiplicity is detected. Consumers should contact the provider for details on the specifications. - `morphologyInd` integer: Morphology indicator. Consumers should contact the provider for details on the specifications. - `neighborId` integer: The catalog ID of the nearest neighbor to this source. - `neighborFlag` boolean: Flag indicating that the nearest catalog neighbor is closer than 4.6 arcseconds. - `neighborDistance` number, double: Distance between source and nearest neighbor, in arcseconds. - `neighborRa` number, double: RA of nearest neighbor measured in degrees. - `neighborDec` number, double: Dec of nearest neighbor measured in degrees. - `numNeighbors` integer: Number of neighbors. - `shiftFlag` boolean: Flag indicating that the photocentric shift is greater than 50 milliarcseconds. - `shift` number, double: Photocentric shift caused by neighbors, in arcseconds. - `shiftFWHM1` number, double: Photocentric shift caused by neighbors, in arcseconds. This value is constrained to a Point Spread Function (PSF) with Full Width at Half Maximum (FWHM) of one arcsecond. - `shiftFWHM6` number, double: Photocentric shift caused by neighbors, in arcseconds. This value is constrained to a Point Spread Function (PSF) with Full Width at Half Maximum (FWHM) of six arcseconds. - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system. - `createdBy` string: Application user who created the row in the database, auto-populated by the system. - `updatedAt` string, date-time: Time the row was last updated in the database, auto-populated by the system. - `updatedBy` string: Application user who updated the row in the database, auto-populated by the system. - `source` string, required: Source of the data. - `origin` string: Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin. - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system. - `dataMode` 'REAL' | 'TEST' | 'EXERCISE' | 'SIMULATED', required: Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data: REAL: Data collected or produced that pertains to real-world objects, events, and analysis. TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics. EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data. SIMULATED: Synthetic data generated by a model to mimic real-world datasets. ## Response `201` Success ## Other responses - `400`: Bad Request - `401`: Invalid/Missing User Credentials - `403`: User Is Not Authorized - `405`: Method Not Allowed - `415`: MediaType Unsupported - `429`: Rate of Requests Exceeds Allowed Limit - `500`: Internal Server Error ## Changes > 12 revisions in range; 1 could not be searched. - **2026-04-09** `bd17bc53681e`: 1 info - the `neighborId` request property format was generalized from `int32` to `int64` - **2026-03-25** `173e4aff893f`: 6 breaking, 13 warning, 84 info - removed the enum value `GAIADR3` of the request property `astrometryOrigin` - removed the enum value `HIPPARCOS` of the request property `astrometryOrigin` - removed the enum value `USNOBSC` of the request property `astrometryOrigin` - the `multiplicity` request property's maxLength was decreased to `8` - …99 more - **2025-10-23** `09bd422d5ac1`: 5 warning - the `allWISEId` request property's maxLength was set to `32` - the `multiplicity` request property's maxLength was set to `32` - the `nonSingleStar` request property's maxLength was set to `32` - the `twoMASSId` request property's maxLength was set to `32` - …1 more - **2025-09-26** `45631f9bb3f0`: 1 breaking, 16 info - the `origNetwork` request property's minLength was increased from `0` to `1` - added the new optional request property `allWISEId` - added the new optional request property `allWISEW1Mag` - added the new optional request property `allWISEW1MagUnc` - …13 more - **2025-04-16** `75f764c843a9`: 2 info - api operation id `create_122` removed and replaced with `` - the endpoint scheme security `BasicAuth` was removed from the API [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/starcatalog/post.md) --- [API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)