🔎Search

Find deep sky objects and stars

Searches the catalogue by name or by position.

Give term to search by name, or rightAscension and declination together to search by position. The two are mutually exclusive.

Find deep sky objects and stars

get

Searches the catalogue either by name or by position. Give term to search by name, or rightAscension and declination together to search by position. The two are mutually exclusive.

Authorizations

AuthorizationstringRequired

The application key, sent as Authorization: Bearer <key>. Keys are never accepted in the query string, where they would be recorded in logs and browser history.

Query parameters

termstring · min: 1Optional

Name or catalogue designation to search for.

Example: andromeda

matchTypestring · enumOptional

How term is matched. v2 spelled this match_type.

Default: fuzzyPossible values:

orderBystring · enumOptional

Field to sort by. v2 spelled this order_by.

Possible values:

rightAscensionnumber · max: 24Optional

Right ascension to search near, in hours. Must be given with declination. v2 called this ra and took it as a string.

declinationnumber · min: -90 · max: 90Optional

Declination to search near, in degrees. Must be given with rightAscension. v2 called this dec and took it as a string.

limitinteger · min: 1 · max: 100Optional

Most results to return. v2 declared this as a string because query parameters arrive as text; v3 declares the type it means.

Default: 20

offsetintegerOptional

Results to skip. Declared as an integer, not a string.

Default: 0

Responses

200

Matching objects.

application/json

400

The request could not be parsed.

application/problem+json

401

The application key was missing or not recognised.

application/problem+json

422

The request was understood but a parameter was unacceptable.

application/problem+json

get/search

GET /api/v3/search HTTP/1.1
Host: api.astronomyapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "limit": 1,
    "offset": 1,
    "total": 1
  },
  "data": [
    {
      "id": "text",
      "name": "Andromeda Galaxy",
      "type": {
        "id": "text",
        "name": "text"
      },
      "subType": {
        "id": "text",
        "name": "text"
      },
      "crossIdentification": [
        {
          "name": "text",
          "catalogId": "text"
        }
      ],
      "rightAscension": 1,
      "declination": 1,
      "formatted": {
        "rightAscension": "text",
        "declination": "text"
      }
    }
  ]
}

Changes from v2

v2	v3
match_type	matchType
order_by	orderBy
ra, dec (strings)	rightAscension, declination (numbers)
limit, offset declared as strings	declared as integers
position.equatorial.rightAscension.hours	rightAscension
position.equatorial.declination.degrees	declination
*.string	formatted.*, with include=formatted

v2 declared limit and offset as strings because query parameters arrive as text. v3 declares the type it means and does the conversion itself.

Examples

By name:

GET /api/v3/search?term=andromeda&matchType=fuzzy&limit=10

By position:

GET /api/v3/search?rightAscension=0.712&declination=41.269