{"size": 1100, "ext": "scrbl", "max_stars_repo_path": "scribblings/solar-flare.scrbl", "max_stars_repo_name": "m-hugi/nasa-open-api", "max_stars_repo_stars_event_min_datetime": null, "max_stars_repo_stars_event_max_datetime": null, "max_issues_repo_path": "scribblings/solar-flare.scrbl", "max_issues_repo_name": "m-hugi/nasa-open-api", "max_issues_repo_issues_event_min_datetime": null, "max_issues_repo_issues_event_max_datetime": null, "max_forks_repo_path": "scribblings/solar-flare.scrbl", "max_forks_repo_name": "m-hugi/nasa-open-api", "max_forks_repo_forks_event_min_datetime": null, "max_forks_repo_forks_event_max_datetime": null}
{"max_stars_count": null, "max_issues_count": null, "max_forks_count": null, "avg_line_length": 33.3333333333, "max_line_length": 94, "alphanum_fraction": 0.5318181818}
#lang scribble/manual

@title{DONKI Solar Flares}

@defproc[(get-solar-flare [dates pair?]
                          [#:api_key       api_key        string? "DEMO_KEY"]) (listof flr?)]{
 Returns list of @racket[flr] within specified date range.
                 
 
 
 @hspace[4] @italic{Dates must be in the form of YYYY-MM-DD.
  (By default, startDate is 30 days ago and endDate is the current date)}
}

@defstruct[flr ([flrID           string?]
                [instruments     (listof flr-instrument?)]
                [beginTime       string?]
                [peakTime        string?]
                [endTime         string?]
                [classType       string?]
                [sourceLocation  string?]
                [activeRegionNum (or/c number? null?)]
                [linkedEvents    (listof string?)]
                [link            string?])]{
 Solar Flare data returned from @racket[get-solar-flare].
}


@defstruct[flr-instrument ([id          number?]
                           [displayName string?])]{
 Instrument used to record Solar Flare data. Found in @racket[flr].
}
