Web API : Programmer's Interface
The Search Tools access FIS or IRC source catalog data via URLs. You can use the URLs as APIs, and set search parameters to obtain required catalog data. API indices of Search Tools are listed up as follows;
API indices of Search Tools:
| Radial Search | Access FIS or IRC source catalog data by the radial search. |
| Rectangular Search | Access FIS or IRC source catalog data by the rectangular search. |
| Object Cross-ID | Access FIS or IRC source catalog data by the cross identification. |
| SQL Search | Access FIS or IRC source catalog data by the SQL search. |
The Visual Tools are also used as APIs, and they accept parameters to obtain the catalog and image data. API indices of Visual Tools are listed up as follows;
API indices of Visual Tools:
| Explore | Browse source catalog data and quicklook images, and access extrenal information. |
| Image List Tool | Create the list of images for user's coordinate list. SDSS, DSS2, 2MASS and IRIS images are supported. |
GET method can be used like this:
http://www.darts.isas.jaxa.jp/astro/akari/cas/tools/search/x_radial.php? coordinate=j2000&lon=266.0&lat=-28.0&radius=90&radius_unit=arcmins& catalog=fis_bsc_1&fqual_65=true&min_fqual_65=3&max_fqual_65=3&fqual_90=true&min_fqual_90=3&max_fqual_90=3& fqual_140=true&min_fqual_140=3&max_fqual_140=3&fqual_160=true&min_fqual_160=3&max_fqual_160=3& db=dr1&columns=all&distance=true&rows=all&limit=10&format=html&delimiter=%2C&newline=lf
The parameters written after the URL are summarized in the table below;
Single Search Mode:
| Parameter | Description |
|---|---|
| catalog or instrument | Catalog name; fis_bsc_1 or irc_psc_1 |
| contents_only | Set true to get HTML body part only. |
Multiple Search Mode:
| Parameter | Description |
|---|---|
| fis_bsc_1 | Set true when searching FIS BSC 1.0. |
| irc_psc_1 | Set true when searching IRC PSC 1.0. |
Common parameters:
| Parameter | Description |
|---|---|
| coordinate | Coordinate system of lon and lat parameters; j2000, b1950, ecliptic, or galactic |
| lon | longitude |
| lat | latitude |
| direct | Set false when using ident_simbad or ident_ned parameter. This parameter can be omitted. |
| ident_simbad | Name to identify by SIMBAD |
| ident_ned | Name to identify by NED |
| radius | Search radius |
| radius_unit | Radius unit; arcmins or arcsecs |
| fqual_65 | Set true when min_fqual_65 and max_fqual_65 is set. fqual_65 is a four level flux quality indicator at the central wavelength 65. |
| fqual_90 | Set true when min_fqual_90 and max_fqual_90 is set. fqual_90 is a four level flux quality indicator at the central wavelength 90. |
| fqual_140 | Set true when min_fqual_140 and max_fqual_140 is set. fqual_140 is a four level flux quality indicator at the central wavelength 140. |
| fqual_160 | Set true when min_fqual_160 and max_fqual_160 is set. fqual_160 is a four level flux quality indicator at the central wavelength 160. |
| fqual_09 | Set true when min_fqual_09 and max_fqual_09 is set. fqual_09 is a two level flux quality indicator at the central wavelength 09. |
| fqual_18 | Set true when min_fqual_18 and max_fqual_18 is set. fqual_18 is a two level flux quality indicator at the central wavelength 18. |
| min_fqual_65 | Minimum value of fqual_65 |
| max_fqual_65 | Maximum value of fqual_65 |
| min_fqual_90 | Minimum value of fqual_90 |
| max_fqual_90 | Maximum value of fqual_90 |
| min_fqual_140 | Minimum value of fqual_140 |
| max_fqual_140 | Maximum value of fqual_140 |
| min_fqual_160 | Minimum value of fqual_160 |
| max_fqual_160 | Maximum value of fqual_160 |
| min_fqual_09 | Minimum value of fqual_09 |
| max_fqual_09 | Maximum value of fqual_09 |
| min_fqual_18 | Minimum value of fqual_18 |
| max_fqual_18 | Maximum value of fqual_18 |
| db | Database name |
| columns | Required columns; all (original table) or digest (view) |
| distance | Set true if `distance' column is required. |
| rows | Required rows; all or limit |
| limit | Row limit |
| format | Output format; html or text |
| types | Set true to show column types in the table header. |
| delimiter | Separator between columns; e.g., `,' |
| newline | Newline charactor(s); lf, crlf or cr |
GET method can be used like this:
https://darts.isas.jaxa.jp/astro/akari/cas/tools/search/x_rect.php? coordinate=j2000&min_lon=180.5&max_lon=200.5&min_lat=1.5&max_lat=3.5& catalog=fis_bsc_1&fqual_65=true&min_fqual_65=3&max_fqual_65=3&fqual_90=true&min_fqual_90=3&max_fqual_90=3& fqual_140=true&min_fqual_140=3&max_fqual_140=3&fqual_160=true&min_fqual_160=3&max_fqual_160=3& db=dr1&columns=digest&rows=limit&limit=10&format=html&delimiter=%2C&newline=lf
The parameters written after the URL are summarized in the table below;
Single Search Mode:
| Parameter | Description |
|---|---|
| catalog or instrument | Catalog name; fis_bsc_1 or irc_psc_1 |
| contents_only | Set true to get HTML body part only. |
Multiple Search Mode:
| Parameter | Description |
|---|---|
| fis_bsc_1 | Set true when searching FIS BSC 1.0. |
| irc_psc_1 | Set true when searching IRC PSC 1.0. |
Common parameters:
| Parameter | Description |
|---|---|
| coordinate | Coordinate system of lon and lat parameters; j2000, b1950, ecliptic, or galactic |
| min_lon | lower limit of longitude |
| max_lon | upper limit of longitude |
| min_lat | lower limit of latitude |
| max_lat | upper limit of latitude |
| fqual_65 | Set true when min_fqual_65 and max_fqual_65 is set. fqual_65 is a four level flux quality indicator at the central wavelength 65. |
| fqual_90 | Set true when min_fqual_90 and max_fqual_90 is set. fqual_90 is a four level flux quality indicator at the central wavelength 90. |
| fqual_140 | Set true when min_fqual_140 and max_fqual_140 is set. fqual_140 is a four level flux quality indicator at the central wavelength 140. |
| fqual_160 | Set true when min_fqual_160 and max_fqual_160 is set. fqual_160 is a four level flux quality indicator at the central wavelength 160. |
| fqual_09 | Set true when min_fqual_09 and max_fqual_09 is set. fqual_09 is a two level flux quality indicator at the central wavelength 09. |
| fqual_18 | Set true when min_fqual_18 and max_fqual_18 is set. fqual_18 is a two level flux quality indicator at the central wavelength 18. |
| min_fqual_65 | Minimum value of fqual_65 |
| max_fqual_65 | Maximum value of fqual_65 |
| min_fqual_90 | Minimum value of fqual_90 |
| max_fqual_90 | Maximum value of fqual_90 |
| min_fqual_140 | Minimum value of fqual_140 |
| max_fqual_140 | Maximum value of fqual_140 |
| min_fqual_160 | Minimum value of fqual_160 |
| max_fqual_160 | Maximum value of fqual_160 |
| min_fqual_09 | Minimum value of fqual_09 |
| max_fqual_09 | Maximum value of fqual_09 |
| min_fqual_18 | Minimum value of fqual_18 |
| max_fqual_18 | Maximum value of fqual_18 |
| db | Database name |
| columns | Required columns; all (original table) or digest (view) |
| rows | Required rows; all or limit |
| limit | Row limit |
| format | Output format; html or text |
| types | Set true to show column types in the table header. |
| delimiter | Separator between columns; e.g., `,' |
| newline | Newline charactor(s); lf, crlf or cr |
This URL:
https://darts.isas.jaxa.jp/astro/akari/cas/tools/search/x_upload.php
accepts POST method. The parameters are summarized in the table below;
| Parameter | Description |
|---|---|
| scope | Search scope; nearobj or allobj |
| radius | Search radius |
| radius_unit | Radius unit; arcmins or arcsecs |
| coordinate | Coordinate system of upload list; j2000, b1950, ecliptic, or galactic |
| paste | user upload list (pasted text of Web UI) |
| upload | user text file to upload |
| MAX_FILE_SIZE | maximum size of the user uploading file; 81920 must be set. |
| req_type | request type; fis_digest, fis_all, fis_summary, fis_sql, irc_digest, irc_all, irc_summary, irc_sql or all_sql |
| fis_bsc_1_cmd | SQL statement for FIS BSC 1.0 |
| irc_psc_1_cmd | SQL statement for IRC PSC 1.0 |
| fis_bsc_1_x_irc_psc_1_cmd | SQL statement for FIS BSC 1.0 + IRC PSC 1.0 |
| db | Database name |
| format | Output format; html or text |
| types | Set true to show column types in the table header. |
| delimiter | Separator between columns; e.g., `,' |
| newline | Newline charactor(s); lf, crlf or cr |
This URL:
https://darts.isas.jaxa.jp/astro/akari/cas/tools/search/x_sql.php
accepts both POST and GET method. Parameters for POST method are summarized in the table below;
| Parameter | Description |
|---|---|
| syntax | Set syntax to check SQL syntax only. |
| cmd | SQL statement |
| format | Output format; html or text |
| types | Set true to show column types in the table header. |
| delimiter | Separator between columns; e.g., `,' |
| newline | Newline charactor(s); lf, crlf or cr |
Parameters of GET method version are shown below;
| Parameter | Description |
|---|---|
| cmd | SQL statement |
| format | Output format; html or text |
| types | Set true to show column types in the table header. |
GET method can be used like this:
https://darts.isas.jaxa.jp/astro/akari/cas/tools/explore/obj.php? catalog=fis_bsc_1&lon=188.578518&lat=6.468562&objsubname=NGC4532
The parameters written after the URL are summarized in the table below;
| Parameter | Description |
|---|---|
| catalog or instrument | Catalog name; fis_bsc_1, irc_psc_1, rc3, iras, irasfsc or twomass |
| radius | Search radius; arcmins |
| coordinate | coordinate system of lon and lat parameters; j2000, b1950, ecliptic, or galactic |
| lon | longitude; deg or `hh:mm:ss.ss' |
| lat | latitude; deg or `[±]dd:mm:ss.s' |
| ident_simbad | Name to identify by SIMBAD |
| ident_ned | Name to identify by NED |
| objid | Object ID |
| scale | Image Scale ("/pix) |
| grid | identifier to display grids; true or false |
| invert | identifier to display an inverted images; true or false |
| objsubname | Object name to be written as subtitle |
This URL:
https://darts.isas.jaxa.jp/astro/akari/cas/tools/chart/list.php
accepts POST method. The parameters are summarized in the table below;
| Parameter | Description |
|---|---|
| image | Selection of image; sdss, dss2, 2mass or iris |
| scale | Image scale ("/pix) |
| grid | identifier to display grids; true or false |
| invert | identifier to display an inverted image; true or false |
| coordinate | coordinate system of list; j2000, b1950, ecliptic, or galactic |
| paste | User list of target coordinates; 1000 targets can be set. Each line of list includes target name (string), longitude (deg or `hh:mm:ss.ss') and latitude (deg or `[±]dd:mm:ss.s') |