AMS RESTFull API v 1.0.0

Getting Started

The AMS API connects your website or application with the data collected on our website.

GET /api_key

Using the AMS API requires an API Key that is provided to paid members or invited scientific organizations and individuals. GET /api_key allows you to generate an API Key based on your AMS credentials or to retrieve your forgotten API Key.

Your API Key is personal and cannot be shared. The AMS API activity is monitored. Any abuse of your API Key will result in banishment.

As we do not use secured access to the API, we recommend logging to the site and using GET /api_key without your credentials to create or retrieve your API Key.

Resource URL

https://www.amsmeteors.org/members/api/open_api/get_api_key

Parameters

email and pwd are required only if you are NOT logged in to the AMS website yet.

Field Type Description
email String

Your email * required if you aren't logged in to the AMS website

pwd String

Your password * required if you aren't logged in to the AMS website

format String
  • txt: TXT format (default)
  • json: JSON or JSONP format

Note: JSONP is default if a callback is detected.

Success (200)

Field Sub-Field Type Description
Result API_Key String

Your API Key.
The API Key is automatically generated the first time you are using the GET /api_key.

Input Email String

The email you passed in

Status Integer 200

Errors

Field Sub-Field Type Description
Errors Banned String

You have been banned. Contact us on www.amsmeteors.org if you want more details.

Authorization String

Only paid members and approved scientific organizations can access the AMS API. Contact us on www.amsmeteors.org if you want more details.

Missing_attribute String

A required attribute is missing (either you are not logged in to the AMS website, or you missed the 2 parameters email and pwd).

Status Integer
  • 401: Unauthorized
  • 404: Not Found
  • 405: Method Not Allowed
{
    "status": 200,
    "input": {
        "email"     : "your@email.com"
    },
    "result": {
        "API_Key"   : "your_api_key"
    }
}
$.ajax({
    type: 'GET',
    url:  'https://www.amsmeteors.org/members/api/open_api/get_api_key',
    data: {
        email   : "your@email.com",
        pwd     : "your_password"
    },
    dataType    : "jsonp",
    cache       : false,
    crossDomain : true,
    success: function(response) {
        if(response.status==200) {
           // Display result on Javascript console
           console.log(response.result);
        } else {
           // Errors result on Javascript console
           console.log(response.errors);
        }
    } 
});
Leave the fields below empty if you are already logged into the AMS website.

GET /get_event

GET /get_event returns a summary of a given event with computed trajectory estimation.

Resource URL

https://www.amsmeteors.org/members/api/open_api/get_event

Parameters

Field Type Description
api_key String

See GET /api_key

year Integer

The year of the event.

event_id Integer

The identification number of the event in the given year.
(ex: for Event #657-2015, year: 2015, event_id: 657)

Options

Field Type Description
format String
  • txt: TXT format (default)
  • json: JSON or JSONP format
  • pipe_sep: Pipe (|) separeted text
  • kml: KML*

Notes:
JSONP is default if a callback is detected.
* KML format can be used only on direct access through URL

threshold Integer

The maximum distance from the intersection point in km (default: 1000km.)

precision Integer

The number of decimal places to display for values (default & max. value: 12.)

ratings Integer

The minimum expertise level of the author of the reports taken into account in the calculation of the trajectory. (default: 1.)

Authors of the report are rated through 5 different levels of expertise.

  • 1- I have no astronomy/observing experience
  • 2- I have some astronomy/observing experience
  • 3- I am a casual observer of meteor showers
  • 4- I observe meteors regularly and consider myself an amateur astronomer
  • 5- I am an expert level observer/astronomer
end_threshold Integer

The maximum distance from the best intersection point in km (default: 150.)

optimize_ratings Boolean

If true, the system optimizes the number of reports to take into account in the calculation of the trajectory based on the level of experience of the witnesses (default: true).

  • If the total number of reports for the event > 500, the minimum level of experience taken into account is 2.
  • If the total number of reports for the event > 800, the minimum level of experience taken into account is 3.
  • If the total number of reports for the event > 1400, the minimum level of experience taken into account is 4.

Success (200)

Field Sub-Field Entry Type Description
Result Event#event_id-year String
  fireball_year String

The year of the fireball (based on UT date & time)

  ams_year_id String

The event ID for the fireball_year year.

  event_id Integer

The unique event ID in the database.

  avg_date_utc String

Average UTC date and time.

  avg_date_local String

Average local date and time.

  timezone String|Integer

Time zone or number of time zones if several time zone

  RA_dec Float

Right Ascension in degrees (calculated.)

  DEC Float

Declination in degrees (calculated.)

  RA String

Right Ascension in Degrees:ArcMinutes (calculated.)

  average_magnitude Integer

The average stellar magnitude of the event (calculated.)

  start_lat Float

The latitude of the starting location where the event was visible (signed degrees format - calculated.)

  start_long Float

The longitude of the starting location where the event was visible (signed degrees format - calculated.)

  start_alt Float

The altitude of the starting location where the event was visible (calculated - in meters.)

  end_lat Float

The latitude of the ending location where the event was visible (signed degrees format - calculated.)

  end_long Float

The longitude of the ending location where the event was visible (signed degrees format - calculated.)

  end_alt Float

The altitude of the ending location where the event was visible (calculated - in meters.)

  impact_lat Float

The latitude of the eventual impact location (signed degrees format - calculated.)

  impact_long Float

The longitude of the eventual impact location (signed degrees format - calculated.)

  epicenter_lat Float

The latitude of the average location of all the witnesses of the event (signed degrees format - calculated.)

  epicenter_long Float

The longitude of the average location of all the witnesses of the event (signed degrees format - calculated.)

  threshold Integer

Value of the options for the current result (see Options)

  min_rating Integer

Value of the options for the current result (see Options)

  end_threshold Integer

Value of the options for the current result (see Options)

  optimized_ratings Integer

Value of the options for the current result (see Options - 1: true, 0:false)

  num_reports_for_options Integer

Number of reports taken into account for the calculation of the trajectory for the current event.

  precision Integer

Value of the options for the current result (see Options)

Input year String

The input year

event_id String

The input event_id

format String

The input format if not JSONP (automatically detected if a callback is present.)

Errors

Field Sub-Field Type Description
Errors Missing_attribute String

A required attribute is missing

API_Key String

Invalid API Key

Intersection String

No intersection found. The event doesn't contain enough data.

Data String

The event doesn't contain enough data.

Criteria String

The event doesn't contain any reports that match the options used for the request.

Event_id String

Invalid Event Id.

Status Integer
  • 401: Unauthorized
  • 404: Not Found
  • 405: Method Not Allowed
{
    "status":200,
    "input": {
        "year"          : "2014",
        "event_id"      : "896",
        "format"        : "json"
    },
    "result":
        {
         "Event #896-2015":
          {
            "fireball_year"     : "2015",
            "ams_year_id"       : "896",
            "event_id"          : 16104,
            "average_magnitude" : -14.25,
            "start_lat"         : 37.722575630079,
            "start_long"        : -123.7188998241,
            "start_alt"         : 80000,
            "end_lat"           : 37.981036977846,
            "end_long"          : -123.34195859671,
            "end_alt"           : 22566.912895576,
            "impact_lat"        : 38.082559283717,
            "impact_long"       : -123.19344889679,
            "epicenter_lat"     : 37.94186,
            "epicenter_long"    : -122.00396,
            "threshold"         : 1000,
            "min_rating"        : 1,
            "end_threshold"     : 150,
            "optimized_ratings" : 1,
            "num_reports_for_options" : 20,
            "RA_dec"            : 182.27552756477,
            "RA"                : "12:09",
            "DEC"               : 10.196441249026,
            "precision"         : 12,
            "avg_date_utc"      : "2015-04-10 09:05:19",
            "avg_date_local"    : "2015-04-10 02:05:19",
            "timezone":"PDT"
          }
        }
}
$.ajax({
    type: 'GET',
    url:  'https://www.amsmeteors.org/members/api/open_api/get_event',
    data: {
        api_key:    "your_api_key",
        year:       2015,
        event_id:   896
    },
    dataType:       "jsonp",
    cache:          false,
    crossDomain:    true,
    success: function(response) {
        if(response.status==200) {
           // Display result on Javascript console
           console.log(response.result);
        } else {
           // Errors result on Javascript console
           console.log(response.errors);
        }
    } 
});

GET /get_events

GET /get_events returns a summary of all events of a given year with computed trajectories estimation.

Resource URL

https://www.amsmeteors.org/members/api/open_api/get_events

Parameters

Field Type Description
api_key String

See GET /api_key

year Integer

The year of the events.

Options

Field Type Description
min_reports String

The minimum number of reports for each events of the current year (default: 10.)

format String
  • txt: TXT format (default)
  • json: JSON or JSONP format
  • pipe_sep: Pipe (|) separeted text
  • kml: KML*

Notes:
JSONP is default if a callback is detected.
* KML format can be used only on direct access through URL

Success (200)

Field Sub-Field Entry Type Description
Result
For each event found:
Event#event_id-year String
  fireball_year String

The year of the fireball (based on UT date & time)

  ams_year_id String

The event ID for the fireball_year year.

  event_id Integer

The unique event ID in the database.

  event_id Integer

The unique event ID in the database.

  avg_date_utc String

Average UTC date and time.

  avg_date_local String

Average local date and time.

  avg_duration String

Average duration of the event.

  RA_dec Float

Right Ascension in degrees (calculated.)

  DEC Float

Declination in degrees (calculated.)

  RA String

Right Ascension in Degrees:ArcMinutes (calculated.)

  average_magnitude Integer

The average stellar magnitude of the event (calculated.)

  start_lat Float

The latitude of the starting location where the event was visible (signed degrees format - calculated.)

  start_long Float

The longitude of the starting location where the event was visible (signed degrees format - calculated.)

  start_alt Float

The altitude of the starting location where the event was visible (calculated - in meters.)

  end_lat Float

The latitude of the ending location where the event was visible (signed degrees format - calculated.)

  end_long Float

The longitude of the ending location where the event was visible (signed degrees format - calculated.)

  end_alt Float

The altitude of the ending location where the event was visible (calculated - in meters.)

  impact_lat Float

The latitude of the eventual impact location (signed degrees format - calculated.)

  impact_long Float

The longitude of the eventual impact location (signed degrees format - calculated.)

  epicenter_lat Float

The latitude of the average location of all the witnesses of the event (signed degrees format - calculated.)

  epicenter_long Float

The longitude of the average location of all the witnesses of the event (signed degrees format - calculated.)

  threshold Integer

Value of the options for the current result (default: 1000)

  min_rating Integer

Value of the options for the current result (depends on the number of reports for the event)

  end_threshold Integer

Value of the options for the current result (default: 150)

  optimized_ratings Integer

Value of the options for the current result (default: 1)

  num_reports_for_options Integer

Number of reports taken into account for the calculation of the trajectory for the current event.

  precision Integer

Value of the options for the current result (default: 12)

  min_hour_diff Integer

Minimum number of hours between the report and the event (default: 48h)

Input year String

The input year

event_id String

The input event_id

format String

The input format if not JSONP (automatically detected if a callback is present.)

Errors

Field Sub-Field Type Description
Errors Missing_attribute String

A required attribute is missing

API_Key String

Invalid API Key

Not_Found String

No event found for your criteria.

Status Integer
  • 401: Unauthorized
  • 404: Not Found
  • 405: Method Not Allowed
{
    "status":200,
    "input": {
        "year"          : "2014",
        "min_reports"   : "1000",
        "format"        : "json"
    },
    "result":
        {
         "Event #3638-2014" : {
             "fireball_year"        : "2014",
             "ams_year_id"          : "3638",
             "event_id"             : 15030,
             "average_magnitude"    : -12.3889,
             "start_lat"            : 42.928398914237,
             "start_long"           : -72.233950137553,
             "start_alt "           : 80000,
             "end_lat"              : 42.097538905514,
             "end_long"             : -74.64254049148,
             "end_alt"              : 50131.720214269,
             "impact_lat"           : 40.588587567159,
             "impact_long"          : -78.537206955971,
             "epicenter_lat"        : 42.053913,
             "epicenter_long"       : -73.098112,
             "threshold"            : 1000,
             "min_rating"           : 4,
             "end_threshold"        : 150,
             "optimized_ratings"    : 1,
             "num_reports_for_options" :54,
             "RA_dec"               : 293.39501275469,
             "RA"                   : "19:33",
             "DEC"                  : 24.717951170647,
             "precision"            : 12,
             "avg_date_utc"         : "2014-12-29 23:34:19",
             "avg_date_local"       : "2014-12-29 18:34:19",
             "timezone"             : "2"
        },
        "Event #2908-2014" :{
             "fireball_year"        : "2014",
             "ams_year_id"          : "2908",
             "event_id"             : 14300,
             "average_magnitude"    : -13.5655,
             "start_lat"            : 38.558858169957,
             "start_long"           : -81.925857877854,
             "start_alt"            : 80000,
             "end_lat"              : 38.439793863792,
             "end_long"             : -80.763337603397,
             "end_alt"              : 15648.711977398,
             "impact_lat"           : 38.41226183314,
             "impact_long"          : -80.480697650261,
             "epicenter_lat"        : 38.098347,
             "epicenter_long"       : -81.567819,
             "threshold"            : 1000,
             "min_rating"           : 3,
             "end_threshold"        : 150,
             "optimized_ratings"    : 1,
             "num_reports_for_options" :335,
             "RA_dec"               : 65.86191232225,
             "RA"                   : "04:23",
             "DEC "                 : 24.344698094895,
             "precision "           : 12,
             "avg_date_utc"         : "2014-11-03 23:25:21",
             "avg_date_local"       : "2014-11-03 18:23:02",
             "timezone"             : "2"
        }  
    }
}
$.ajax({
    type: 'GET',
    url:  'https://www.amsmeteors.org/members/api/open_api/get_events',
    data: {
        api_key     : "your_api_key",
        year        : 2014,
        min_reports : 1000
    },
    dataType:"jsonp",
    cache: false,
    crossDomain: true,
    success: function(response) {
        if(response.status==200) {
           // Display result on Javascript console
           console.log(response.result);
        } else {
           // Errors result on Javascript console
           console.log(response.errors);
        }
    } 
});

GET /get_reports_for_event

GET /get_reports_for_event returns all reports associated with a given event.

Resource URL

https://www.amsmeteors.org/members/api/open_api/get_reports_for_event

Parameters

Field Type Description
api_key String

See GET /api_key

year Integer

The year of the event.

event_id Integer

The identification number of the event in the given year.
(ex: for Event #657-2015, year: 2015, event_id: 657)

Options

Field Type Description
format String
  • txt: TXT format (default)
  • json: JSON or JSONP format
  • pipe_sep: Pipe (|) separeted text

Note: JSONP is default if a callback is detected.

Success (200)

Field Sub-Field Entry Type Description
Result
For each report:
Report #report_id String
  report_id String

The ID of the report.

  org String

The organization code that tells from where the report has been posted.

  witness_id String

The unique witness (report) for the current event (alphabetic format.)

  city String

The city from where the witness saw the event (usually the closest city - if any.)

  state String

The state from where the witness saw the event (if any.)

  country String

The country code (ISO 3166-1 alpha-2 format) from where the witness saw the event (if any.)

  report_date_local String

The local date and time (yyyy-mm-dd hh:ii:ss format) when the witness saw the event (if any.)

  report_date_utc String

The UT date and time (yyyy-mm-dd hh:ii:ss format) when the witness saw the event (if any.)

  timezone String

The standard abbreviation of the timezone inside which the witness was when he saw the event (if any.)

  latitude String

The latitude of the witness location when he saw the event (signed degrees format).

  longitude String

The longitude of the witness location when he saw the event (signed degrees format).

  altitude String

The altitude of the witness location when he saw the event (in meters).

  moving_direction String

The moving direction of the phenomena based on the witness location.

Possible values:

  • RightToLeft
  • LeftToRight
  • DownToUp
  • UpToDown
  • DownRightToUpLeft
  • UpRightToDownLeft
  • DownLeftToUpRight
  • UpLeftToDownRight
  • Unknown
  magnitude String

The magnitude of the phenomena estimated by the witness.

  duration String

The duration of the phenomena estimated by the witness (in seconds).

  color String

The color(s) of the phenomena estimated by the witness.

  looking_azimuth String

The azimuth of the direction in which the witness was looking at when he saw the phenomena (signed degrees format.)

  initial_azimuth String

The azimuth of the direction in which the witness saw the phenomena for the first time (signed degrees format.)

  final_azimuth String

The azimuth of the direction in which the witness saw the phenomena for the last time (signed degrees format.)

  initial_altitude String

The estimated altitude of the phenomena when he first appeared to the witness (degrees format.)

  final_altitude String

The estimated altitude of the phenomena when he last appeared to the witness (degrees format.)

  train String

Presence of a train.

Possible values:

  • YES
  • NO
  • UNKNOWN
  train_duration String

The duration of the train estimated by the witness (in seconds.)

  train_length String

The length of the train estimated by the witness (in degrees.)

  train_remarks String

Remarks about the train.

  terminal_flash String

Presence of a terminal flash.

Possible values:

  • YES
  • NO
  • UNKNOWN
  terminal_flash_remarks String

Remarks about the terminal flash.

  fragmentation String

Presence of fragmention.

Possible values:

  • YES
  • NO
  • UNKNOWN
  fragmentation_remarks String

Remarks about the fragmentation.

  concurrent_sound String

Presence of a concurrent sound.

Possible values:

  • YES
  • NO
  • UNKNOWN
  concurrent_sound_remarks String

Remarks about the concurrent sound.

  delayed_sound String

Presence of a delayed sound.

Possible values:

  • YES
  • NO
  • UNKNOWN
  delayed_sound_remarks String

Remarks about the delayed sound.

  rating String

Level of experience of the witness

Possible value:

  • 1 (I have no astronomy/observing experience)
  • 2 (I have some astronomy/observing experience)
  • 3 (I am a casual observer of meteor showers)
  • 4 (I observe meteors regularly and consider myself an amateur astronomer)
  • 5 (I am an expert level observer/astronomer)
  record_date String

Date and time of the report record (yyyy-mm-dd hh:ii:ss format).

  first_name String

The first name of the witness (if any.)

  last_name String

The first letter of the last name of the witness (if any.)

  descent_angle String

The descent angle of the phenomenon estimated by the witness relatively to his/her position (if any.)

  event String

Event#event_id-year

Input year String

The input year

event_id String

The input event_id

format String

The input format if not JSONP (automatically detected if a callback is present.)

Errors

Field Sub-Field Type Description
Errors Missing_attribute String

A required attribute is missing

API_Key String

Invalid API Key

Not_found String

Wrong event ID.

Status Integer
  • 401: Unauthorized
  • 404: Not Found
  • 405: Method Not Allowed
{
    "status"    : 200,
    "input"     : {
            "year"          :   "2014",
            "event_id"      :"9",
            "format"        :"json"
    },
    "result"     : {
            "Report #9-2014a" : {
                "report_id"     : "41414",
                "org"           : "AMS",
                "witness_id"    : "a",
                "city"          : "woodland park",
                "state"         : "CO",
                "country"       : "US",
                "report_date_local" : "2014-01-02 06:15:00",
                "report_date_utc"   : "2014-01-02 13:15:00",
                "timezone"      : "MST",
                "latitude"      : "38.988214",
                "longitude"     : "-105.083404",
                "altitude"      : "0.000000",
                "moving_direction"  : "UpToDown",
                "magnitude"     : "-5.00",
                "duration"      : "3.50",
                "color"         : "yellow, red, white",
                "looking_azimuth"   : "180.00000",
                "initial_azimuth"   : "180.00000",
                "initial_altitude"  : "45",
                "final_azimuth"     : "180.00000",
                "final_altitude"    : "30",
                "train"         : "YES",
                "train_duration"    : "2.00",
                "train_length"      : "5.00",
                "train_remarks"     : "Glowing",
                "terminal_flash"    : "YES",
                "terminal_flash_remarks"    : "",
                "fragmentation"             : "UNKNOWN",
                "fragmentation_remarks"     : "",
                "concurrent_sound"  : "NO",
                "concurrent_sound_remarks"  : "",
                "delayed_sound"     : "UNKNOWN",
                "delayed_sound_remarks"     : "",
                "general_remarks"   : "",
                "rating"        : "3",
                "record_date"   : "2014-01-02 22:30:32",
                "first_name"    : "shane",
                "last_name"     : "m",
                "descent_angle" : "180.00",
                "event"         : "#9-2014"
            },
            "Report #9-2014b":{
                "report_id"     : "41440",
                "org"           : "AMS",
                "witness_id"    : "b",
                "city"          : "Harvey",
                "state"         : "ND",
                "country"       : "US",
                "report_date_local" : "2014-01-02 07:17:00",
                "report_date_utc"   : "2014-01-02 13:17:00",
                "timezone"      : "CST",
                "latitude"      : "47.668325",
                "longitude"     : "-99.926649",
                "altitude"      : "498.520935",
                "moving_direction"  : "UpToDown",
                "magnitude"     : "-16.00",
                "duration"      : "1.50",
                "color"         : "White",
                "looking_azimuth"   : "10.00000",
                "initial_azimuth"   : "0.25000",
                "initial_altitude"  : "57",
                "final_azimuth"     : "1.98000",
                "final_altitude"    : "28",
                "train"         : "UNKNOWN",
                "train_duration"    : "0.00",
                "train_length"  : "0.00",
                "train_remarks" : "",
                "terminal_flash"    : "NO",
                "terminal_flash_remarks"    : "",
                "fragmentation" : "NO",
                "fragmentation_remarks"     : "",
                "concurrent_sound"  : "NO",
                "concurrent_sound_remarks"  :"",
                "delayed_sound"     : "NO",
                "delayed_sound_remarks" : "",
                "general_remarks"   : "was driving north.. object was bright for a few seconds.",
                "rating"        : "2",
                "record_date"   : "2014-01-03 22:46:16",
                "first_name"    : "Brian",
                "last_name"     : "G",  
                "descent_angle" : "180.00",
                "event"         : "#9-2014"
            }
    }
}
$.ajax({
    type: 'GET',
    url:  'https://www.amsmeteors.org/members/api/open_api/get_reports_for_event',
    data: {
        api_key     : "your_api_key",
        year        : 2014,
        event_id    : 9
    },
    dataType:"jsonp",
    cache: false,
    crossDomain: true,
    success: function(response) {
        if(response.status==200) {
           // Display result on Javascript console
           console.log(response.result);
        } else {
           // Errors result on Javascript console
           console.log(response.errors);
        }
    } 
});

GET /get_report

GET /get_report returns all reports for a given year.

Resource URL

https://www.amsmeteors.org/members/api/open_api/get_report

Parameters

Field Type Description
api_key String

See GET /api_key

year Integer

The year you want all the reports from.

Options

Field Type Description
format String
  • txt: TXT format (default)
  • json: JSON or JSONP format
  • pipe_sep: Pipe (|) separeted text

Note: JSONP is default if a callback is detected.

Success (200)

Field Sub-Field Entry Type Description
Result
For each report:
Report #report_id String
  report_id String

The ID of the report.

  org String

The organization code that tells from where the report has been posted.

  witness_id String

The unique witness (report) for the current event (alphabetic format.)

  city String

The city from where the witness saw the event (usually the closest city - if any.)

  state String

The state from where the witness saw the event (if any.)

  country String

The country code (ISO 3166-1 alpha-2 format) from where the witness saw the event (if any.)

  report_date_local String

The local date and time (yyyy-mm-dd hh:ii:ss format) when the witness saw the event (if any.)

  report_date_utc String

The UT date and time (yyyy-mm-dd hh:ii:ss format) when the witness saw the event (if any.)

  timezone String

The standard abbreviation of the timezone inside which the witness was when he saw the event (if any.)

  latitude String

The latitude of the witness location when he saw the event (signed degrees format).

  longitude String

The longitude of the witness location when he saw the event (signed degrees format).

  altitude String

The altitude of the witness location when he saw the event (in meters).

  moving_direction String

The moving direction of the phenomena based on the witness location.

Possible values:

  • RightToLeft
  • LeftToRight
  • DownToUp
  • UpToDown
  • DownRightToUpLeft
  • UpRightToDownLeft
  • DownLeftToUpRight
  • UpLeftToDownRight
  • Unknown
  magnitude String

The magnitude of the phenomena estimated by the witness.

  duration String

The duration of the phenomena estimated by the witness (in seconds).

  color String

The color(s) of the phenomena estimated by the witness.

  looking_azimuth String

The azimuth of the direction in which the witness was looking at when he saw the phenomena (signed degrees format.)

  initial_azimuth String

The azimuth of the direction in which the witness saw the phenomena for the first time (signed degrees format.)

  final_azimuth String

The azimuth of the direction in which the witness saw the phenomena for the last time (signed degrees format.)

  initial_altitude String

The estimated altitude of the phenomena when he first appeared to the witness (degrees format.)

  final_altitude String

The estimated altitude of the phenomena when he last appeared to the witness (degrees format.)

  train String

Presence of a train.

Possible values:

  • YES
  • NO
  • UNKNOWN
  train_duration String

The duration of the train estimated by the witness (in seconds.)

  train_length String

The length of the train estimated by the witness (in degrees.)

  train_remarks String

Remarks about the train.

  terminal_flash String

Presence of a terminal flash.

Possible values:

  • YES
  • NO
  • UNKNOWN
  terminal_flash_remarks String

Remarks about the terminal flash.

  fragmentation String

Presence of fragmention.

Possible values:

  • YES
  • NO
  • UNKNOWN
  fragmentation_remarks String

Remarks about the fragmentation.

  concurrent_sound String

Presence of a concurrent sound.

Possible values:

  • YES
  • NO
  • UNKNOWN
  concurrent_sound_remarks String

Remarks about the concurrent sound.

  delayed_sound String

Presence of a delayed sound.

Possible values:

  • YES
  • NO
  • UNKNOWN
  delayed_sound_remarks String

Remarks about the delayed sound.

  rating String

Level of experience of the witness

Possible value:

  • 1 (I have no astronomy/observing experience)
  • 2 (I have some astronomy/observing experience)
  • 3 (I am a casual observer of meteor showers)
  • 4 (I observe meteors regularly and consider myself an amateur astronomer)
  • 5 (I am an expert level observer/astronomer)
  record_date String

Date and time of the report record (yyyy-mm-dd hh:ii:ss format).

  first_name String

The first name of the witness (if any.)

  last_name String

The first letter of the last name of the witness (if any.)

  descent_angle String

The descent angle of the phenomenon estimated by the witness relatively to his/her position (if any.)

  event String

Event#event_id-year

Input year String

The input year

event_id String

The input event_id

format String

The input format if not JSONP (automatically detected if a callback is present.)

Errors

Field Sub-Field Type Description
Errors Missing_attribute String

A required attribute is missing

API_Key String

Invalid API Key

Not_found String

No report found for the year.

Status Integer
  • 401: Unauthorized
  • 404: Not Found
  • 405: Method Not Allowed
{
    "status"    : 200,
    "input"     : {
            "year"          :   "2014",
            "format"        :"json"
    },
    "result"     : {
            "Report #9-2014a" : {
                "report_id"     : "41414",
                "org"           : "AMS",
                "witness_id"    : "a",
                "city"          : "woodland park",
                "state"         : "CO",
                "country"       : "US",
                "report_date_local" : "2014-01-02 06:15:00",
                "report_date_utc"   : "2014-01-02 13:15:00",
                "timezone"      : "MST",
                "latitude"      : "38.988214",
                "longitude"     : "-105.083404",
                "altitude"      : "0.000000",
                "moving_direction"  : "UpToDown",
                "magnitude"     : "-5.00",
                "duration"      : "3.50",
                "color"         : "yellow, red, white",
                "looking_azimuth"   : "180.00000",
                "initial_azimuth"   : "180.00000",
                "initial_altitude"  : "45",
                "final_azimuth"     : "180.00000",
                "final_altitude"    : "30",
                "train"         : "YES",
                "train_duration"    : "2.00",
                "train_length"      : "5.00",
                "train_remarks"     : "Glowing",
                "terminal_flash"    : "YES",
                "terminal_flash_remarks"    : "",
                "fragmentation"             : "UNKNOWN",
                "fragmentation_remarks"     : "",
                "concurrent_sound"  : "NO",
                "concurrent_sound_remarks"  : "",
                "delayed_sound"     : "UNKNOWN",
                "delayed_sound_remarks"     : "",
                "general_remarks"   : "",
                "rating"        : "3",
                "record_date"   : "2014-01-02 22:30:32",
                "first_name"    : "shane",
                "last_name"     : "m",
                "descent_angle" : "180.00",
                "event"         : "#9-2014"
            },
            [...]
    }
}
$.ajax({
    type: 'GET',
    url:  'https://www.amsmeteors.org/members/api/open_api/get_report',
    data: {
        api_key     : "your_api_key",
        year        : 2014
    },
    dataType:"jsonp",
    cache: false,
    crossDomain: true,
    success: function(response) {
        if(response.status==200) {
           // Display result on Javascript console
           console.log(response.result);
        } else {
           // Errors result on Javascript console
           console.log(response.errors);
        }
    } 
});

GET /get_close_reports

GET /get_close_reports returns all reports (pending or not) betwen a start and an end date. All reports that are not pending are clearly associated to an event in the results.
If a latitude and a longitude are passed in parameters, only the reports from which the witness was less than max_distancekm away from this location.

Resource URL

https://www.amsmeteors.org/members/api/open_api/get_close_reports

Parameters

Field Type Description
api_key String

See GET /api_key

start_date Date

The start date you want all the reports from - format YYYY-mm-dd (ex: 2020-10-21 for today)

end_date Date

The end date you want all the reports from - format YYYY-mm-dd (ex: 2020-10-21 for today)

Options

Field Type Description
pending_only Boolean (int)

If true (1), only pending reports will be returned (default).
If true (0), both pending and approved reports will be returned.

lat Float

The latitude in degrees of the origin point from where the maximum distance is calculated (required when a longitude is passed in paramaters).

lng Float

The longitude in degrees of the origin point from where the maximum distance is calculated (required when a latitude is passed in paramaters).

max_distance Float

The maximum distance in kilometers between the origin point and the location of the witness (default: 400).

format String
  • txt: TXT format (default)
  • json: JSON or JSONP format
  • pipe_sep: Pipe (|) separeted text

Note: JSONP is default if a callback is detected.

Success (200)

Field Sub-Field Entry Type Description
Result
For each report:
Report #event_id-year report_code String (for reports linked to an event)
Report #report_id String (for pending reports)
  report_id String

The ID of the report.

  org String

The organization code that tells from where the report has been posted.

  witness_id String

The unique witness (report) for the current event (alphabetic format.)

  city String

The city from where the witness saw the event (usually the closest city - if any.)

  state String

The state from where the witness saw the event (if any.)

  country String

The country code (ISO 3166-1 alpha-2 format) from where the witness saw the event (if any.)

  report_date_local String

The local date and time (yyyy-mm-dd hh:ii:ss format) when the witness saw the event (if any.)

  report_date_utc String

The UT date and time (yyyy-mm-dd hh:ii:ss format) when the witness saw the event (if any.)

  timezone String

The standard abbreviation of the timezone inside which the witness was when he saw the event (if any.)

  latitude String

The latitude of the witness location when he saw the event (signed degrees format).

  longitude String

The longitude of the witness location when he saw the event (signed degrees format).

  altitude String

The altitude of the witness location when he saw the event (in meters).

  moving_direction String

The moving direction of the phenomena based on the witness location.

Possible values:

  • RightToLeft
  • LeftToRight
  • DownToUp
  • UpToDown
  • DownRightToUpLeft
  • UpRightToDownLeft
  • DownLeftToUpRight
  • UpLeftToDownRight
  • Unknown
  magnitude String

The magnitude of the phenomena estimated by the witness.

  duration String

The duration of the phenomena estimated by the witness (in seconds).

  color String

The color(s) of the phenomena estimated by the witness.

  looking_azimuth String

The azimuth of the direction in which the witness was looking at when he saw the phenomena (signed degrees format.)

  initial_azimuth String

The azimuth of the direction in which the witness saw the phenomena for the first time (signed degrees format.)

  final_azimuth String

The azimuth of the direction in which the witness saw the phenomena for the last time (signed degrees format.)

  initial_altitude String

The estimated altitude of the phenomena when he first appeared to the witness (degrees format.)

  final_altitude String

The estimated altitude of the phenomena when he last appeared to the witness (degrees format.)

  train String

Presence of a train.

Possible values:

  • YES
  • NO
  • UNKNOWN
  train_duration String

The duration of the train estimated by the witness (in seconds.)

  train_length String

The length of the train estimated by the witness (in degrees.)

  train_remarks String

Remarks about the train.

  terminal_flash String

Presence of a terminal flash.

Possible values:

  • YES
  • NO
  • UNKNOWN
  terminal_flash_remarks String

Remarks about the terminal flash.

  fragmentation String

Presence of fragmention.

Possible values:

  • YES
  • NO
  • UNKNOWN
  fragmentation_remarks String

Remarks about the fragmentation.

  concurrent_sound String

Presence of a concurrent sound.

Possible values:

  • YES
  • NO
  • UNKNOWN
  concurrent_sound_remarks String

Remarks about the concurrent sound.

  delayed_sound String

Presence of a delayed sound.

Possible values:

  • YES
  • NO
  • UNKNOWN
  delayed_sound_remarks String

Remarks about the delayed sound.

  rating String

Level of experience of the witness

Possible value:

  • 1 (I have no astronomy/observing experience)
  • 2 (I have some astronomy/observing experience)
  • 3 (I am a casual observer of meteor showers)
  • 4 (I observe meteors regularly and consider myself an amateur astronomer)
  • 5 (I am an expert level observer/astronomer)
  record_date String

Date and time of the report record (yyyy-mm-dd hh:ii:ss format).

  first_name String

The first name of the witness (if any.)

  last_name String

The first letter of the last name of the witness (if any.)

  descent_angle String

The descent angle of the phenomenon estimated by the witness relatively to his/her position (if any.)

  event String

Event#event_id-year

Input year String

The input year

event_id String

The input event_id

format String

The input format if not JSONP (automatically detected if a callback is present.)

Errors

Field Sub-Field Type Description
Errors Missing_attribute String

A required attribute is missing

API_Key String

Invalid API Key

Not_found String

No report found for the year.

Status Integer
  • 401: Unauthorized
  • 404: Not Found
  • 405: Method Not Allowed
{
"status":200,
"input": {
    "start_date" : "2016-09-8",
    "end_date" : "2016-09-13",
    "format" : "json"
 },
 "result": {
    "Report #3325-2016 a":
    {
            "report_id" : "94689",
            "org":"AMS",
            "witness_id":"a",
            "city":"Titusville",
            "state":"FL"
            [...]
    }
}
$.ajax({
    type: 'GET',
    url:  'https://www.amsmeteors.org/members/api/open_api/get_close_reports',
    data: {
        api_key     : "your_api_key",
        start_date        : "2016-09-08",
        end_date	: "2016-09-13",
        pending_only: 1
    },
    dataType:"jsonp",
    cache: false,
    crossDomain: true,
    success: function(response) {
        if(response.status==200) {
           // Display result on Javascript console
           console.log(response.result);
        } else {
           // Errors result on Javascript console
           console.log(response.errors);
        }
    } 
});