lasair 0.0.1

A client for the Lasair database

lasair_api

Client package for Lasair

NAME lasair - Lasair API

DESCRIPTION This class enables programmatic access to the Lasair database and Sherlock service, as described at http://lasair-iris.roe.ac.uk/api/.

Args:
    token (string): The Calls are throttled by the lasair server, by use of an 
    'authorization token', as described in the api documentation above. 
    There is a free token listed there, but it is throttled at 10 calls per hour. 
    Once a user has an account at the Lasair webserver, they can get their own token
    allowing 100 calls per hour, or request to be a power user, with infinite usage.

    cache (string): Results can be cached on a local filesystem, by providing 
    the name of a writable directory. If the same calls are made repeatedly, 
    this will be much more efficient.

CLASSES class lasair_client(builtins.object) lasair_client(token, cache=None)

   Methods defined here:
   
   __init__(self, token, cache=None)
       Initialize self.  See help(type(self)) for accurate signature.
   
   cone(self, ra, dec, radius=5, requestType='all')
       Run a cone search on the Lasair database.
       Args:
           ra (float): Right Ascension in decimal degrees
           dec (float): Declination in decimal degrees
           radius (float): cone radius in arcseconds (default is 5)
           requestType: Can be 'all' to return all objects in the cone
               Can be 'nearest', only the nearest object within the cone
               Can be 'count', the number of objects within the cone
       
       Returns a dictionary with:
           objectId: The ID of the nearest object
           separation: the separation in arcseconds
   
   fetch(self, method, input)
   
   fetch_from_server(self, method, input)
   
   hash_it(self, input)
   
   lightcurves(self, objectIds)
       Get simple lightcurves in machine-readable form
       args:
           objectIds: list of objectIds, maximum 10
       return:
           list of dictionaries, one for each objectId. Each of these
           is a list of dictionaries, each having attributes
           candid, fid, magpsf, sigmapsf, isdiffpos, mjd
   
   objects(self, objectIds)
       Get object pages in machine-readable form
       args:
           objectIds: list of objectIds, maximum 10
       return:
           list of dictionaries, each being all the information presented
           on the Lasair object page.
   
   query(self, selected, tables, conditions, limit=1000, offset=0)
       Run a database query on the Lasair server.
       args: 
           selected (string): The attributes to be returned by the query
           tables (string): Comma-separated list of tables to be joined
           conditions (string): the "WHERE" criteria to restrict what is returned
           limit: (int) (default 1000) the maximum number of records to return
           offset: (int) (default 0) offset of record number
       return:
           a list of dictionaries, each representing a row
   
   sherlock_objects(self, objectIds, lite=True)
       Query the Sherlock database for context information about objects
           in the database.
       args:
           objectsIds: list of objectIds, maximum 10
           lite (boolean): If true, get extended information including a 
               list of possible crossmatches.
       return:
           list of dictionaries, one for each objectId.
   
   sherlock_position(self, ra, dec, lite=True)
       Query the Sherlock database for context information about a position
           in the sky.
       args:
           ra (float): Right Ascension in decimal degrees
           dec (float): Declination in decimal degrees
           lite (boolean): If true, get extended information including a 
               list of possible crossmatches.
       return:
           dictionary of contect information
   
   streams(self, topic, limit=1000)
       Get records from a given stream
       args:
           topic (string): Name of stream to be returned.
       return:
           list of dictionaries, each representing a row
   
   streams_topics(self, regex='.*', limit=1000)
       Get a list of available streams that match a given expression.
       args:
           regex (string, default .*): Search for stream names that match a pattern
           limit: (int, default 1000): Maximum number of stream names to return.
       return:
           List of stream names