developers.lco.globalLCO Developers

NAV Python Javascript Introduction Example usage and code samples will appear on this column. Choose which language lies to both the line and grid patterns. num_rows false The number rows in the grid mosaic pattern, which are the number of pointings in the vertical / declination direction. num_columns false The number of columns in the grid mosaic pattern, which are the number of pointings in the horizontal/ right ascension direction. center false false If true, the line or grid pattern are centered around the initial target. If false (default), the generated pattern starts at the initial target. Airmass requests . get ( ’https://observe.lco.global/api/requests/12345/airmass/’ ) . json () $ . getJSON ( ’https://observe.lco.global/api/requests/12345/airmass/’ ) Returns the response: { "airmass_data" : { "cpt" : { "times" : [ "2017-03-10T00:00" , "2017-03-10T00:10" , "2017-03-10T00:20" , ], "airmasses" : [ 1.1742551260332688 , 1.1956410351734084 , 1.2190628569952935 , ] }, "lsc" : { "times" : [ "2017-03-10T00:00" , "2017-03-10T00:10" , "2017-03-10T00:20" , ], "airmasses" : [ 1.4136946116338753 , 1.374117740986236 , 1.3379014027310017 , ] } }, "airmass_limit" : 2.0 } Authentication Required For a specific Request , return the airmasses of the Target in the first Configuration from the sites for which it is visible in 10 minute intervals. The max_airmass in the first Configuration ’s Constraints is used to determine visibility from a site. HTTP Request GET https://observe.lco.global/api/requests/id/airmass/ Query Parameters Parameter Required Default Description id true The id of the Request . Code Samples Observation API Examples This is a collection of scripts that demonstrate various functions of the API. View on Github Proposals Api root: https://observe.lco.global/api/proposals The proposals API provides endpoints for retrieving information pertaining to proposals such as time used, time allocated, principal investigators (PIs), co-investigators (CoIs), etc. Migration from V2 to V3 of the Observations API Note that there have been slight changes to time allocations with this change of the API. The TARGET_OF_OPPORTUNITY (TOO) type of time has been renamed to RAPID_RESPONSE (RR), and a TIME_CRITICAL (TC) type time has been added. In addition, within a timeallocation, the telescope_class field has been removed and the instrument_name field has been renamed to instrument_types . Proposal Definition A sample Proposal returned via API: { "id" : "LCOTest-001" , "timeallocation_set" : [ { "std_allocation" : 25.0 , "std_time_used" : 14.3253 , "ipp_limit" : 0.0 , "ipp_time_available" : 0.0 , "rr_allocation" : 0.0 , "rr_time_used" : 0.0 , "tc_allocation" : 0.0 , "tc_time_used" : 0.0 , "instrument_types" : [ "1M0-SCICAM-SINISTRO" ], "semester" : "2017AB" , "proposal" : "LCOTest-001" } ], "users" : { "isaac_newton" :{ "first_name" : "Issac" , "last_name" : "Newton" , "time_limit" : 3600 }, "ggalileo@lco.global" :{ "first_name" : "Galileo" , "last_name" : "Galilei" , "time_limit" : -1 , } }, "pi" : "isaac_newton" , "active" : false , "title" : "Study fun things" , "abstract" : "This work is to ..." , "tac_priority" : 1000 , "tac_rank" : 0 , "public" : false , "tag" : "LCO" } Field Description id The id of this Proposal . timeallocation_set Time allocation information associated with this Proposal . users The set of users (PIs and CoIs) associated with this Proposal and their associated time information (in seconds). pi The PI for this Proposal . active Boolean field indicating whether UserRequest s can currently be submitted with this Proposal . title The title of the Proposal . abstract The abstract of the Proposal . tac_priority The priority of the Proposal as awarded by the TAC. tac_rank The numerical ranking given to the Proposal by the TAC. tag The group of which this Proposal is a part. Authentication Authentication for the proposals API is exactly the same as the Observations API . Get all Proposals requests . get ( ’https://observe.lco.global/api/proposals/’ ) $ . getJSON ( ’https://observe.lco.global/api/proposals/’ ) Returns the response: { "count" : 2 , "next" : null , "previous" : null , "results" : [ { "id" : "LCOEPO1" , "timeallocation_set" : [ { "std_allocation" : 15.0 , "std_time_used" : 4.754 , "ipp_limit" : 1.5 , "ipp_time_available" : 0.75 , "rr_allocation" : 0.0 , "rr_time_used" : 0.0 , "tc_allocation" : 0.0 , "tc_time_used" : 0.0 , "instrument_types" : [ "1M0-SCICAM-SINISTRO" ], "semester" : "2016A" , "proposal" : "WhiteFuzzies" }, ], "users" : [ "bilbo@baggins.com" , "darth.vader@empire.uk" , "mario@plumbers.com" ], "pi" : "darth.vader@empire.uk" , "active" : true , "title" : "Observations of Stuff in the Sky" , "abstract" : "We want pretty pictures" , "tac_priority" : 1 , "tac_rank" : 1 , "public" : false , "tag" : "LCO" }, { "id" : "LCOEPO2" , "timeallocation_set" : [ { "std_allocation" : 63.0 , "std_time_used" : 21.0 , "ipp_limit" : 0.0 , "ipp_time_available" : 0.0 , "rr_allocation" : 2.0 , "rr_time_used" : 0.0 , "tc_allocation" : 2.0 , "tc_time_used" : 0.0 , "instrument_types" : [ "1M0-SCICAM-SINISTRO" ], "semester" : "2014B" , "proposal" : "LCOEPO2" } ], "users" : { "steve.pete@downhill.eu" :{ "first_name" : "Steve" , "last_name" : "Pete" , "time_limit" : 240 , }, "aaron.gwin@fast.com" :{ "first_name" : "Aaron" , "last_name" : "Gwin" , "time_limit" : 3400 , } }, "pi" : "aaron.gwin@fast.com" , "active" : false , "title" : "Observing Mars" , "abstract" : "Mars observations" , "tac_priority" : 2 , "tac_rank" : 2 , "public" : false , "tag" : "LCO" }, ] } Authentication Required Returns a list of Proposal s that belong to the authenticated user. Time allocation information contains the observing time in hours granted to a proposal for a single semester and instrument type. HTTP Request GET https://observe.lco.global/api/proposals/ Query Parameters See Proposal Definition for parameters Get Single Proposal requests . get ( ’https://observe.lco.global/api/proposals/LCOEPO1/’ ) $ . getJSON ( ’https://observe.lco.global/api/proposals/LCOEPO1/’ ) Returns the response: { "id" : "LCOEPO1" , "timeallocation_set" : [ { "std_allocation" : 15.0 , "std_time_used" : 4.754 , "ipp_limit" : 1.5 , "ipp_time_available" : 0.75 , "rr_allocation" : 0.0 , "rr_time_used" : 0.0 , "tc_allocation" : 0.0 , "tc_time_used" : 0.0 , "instrument_types" : [ "1M0-SCICAM-SINISTRO" ], "semester" : "2016A" , "proposal" : "WhiteFuzzies" }, ], "users" : { "bilbo@baggins.com" : { "first_name" : "Bilbo" , "last_name" : "Baggins" , "time_limit" : 454 , }, "darth.vader@empire.uk" : { "first_name" : "Anakin" , "last_name" : "Skywalker" , "time_limit" : 2100 , } }, "pi" : "darth.vader@empire.uk" , "active" : true , "title" : "Observations of Stuff in the Sky" , "abstract" : "We want pretty pictures" , "tac_priority" : 1 , "tac_rank" : 1 , "public" : false , "tag" : "LCO" } Authentication Required Return information on a single Proposal . HTTP Request GET https://observe.lco.global/api/proposals/id/ Query Parameters Parameter Required Default Description id true The id of the Proposal . Semesters LCO organizes time into Semester s which are not all of uniform length. This API provides a convenient way to see when semesters start and end. Semesters Definition Field Description id The id of this Semester . start The start time of the Semester . end The end time of the Semester . API root: https://observe.lco.global/api/semesters/ Get All Semesters requests . get ( ’https://observe.lco.global/api/semesters/’ ) . json () $ . getJSON ( ’https://observe.lco.global/api/semesters/’ ) Returns the response: { "count" : 9 , "next" : null , "previous" : null , "results" : [ { "id" : "2016B" , "start" : "2016-10-01T00:00:00Z" , "end" : "2017-03-31T23:59:59Z" }, { "id" : "2016A" , "start" : "2016-04-01T00:00:00Z" , "end" : "2016-09-30T23:59:59Z" }, ... ] } Requesting the semester that contains the date 4-10-2017: requests . get (...