Best places for a life category

POST

/acg/best-places

request.sh

curl -X POST https://api.astroway.info/v1/acg/best-places \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "date": "1990-05-15", "time": "14:30:00", "timezoneOffset": 3, "category": "career", "countries": [ "UA", "PL" ], "orbKm": 1126, "limit": 25, "sort": "net" }'

▸ Спробувати POST /acg/best-places

• Production

Rank cities against the astrocartography lines of a chart for one of the 19 life categories. Distance to a line is computed from the body hour angle and altitude rather than against a discretised polyline, so it is exact: the distance to a horizon line IS the altitude in degrees of arc, and a meridian line offset is the hour angle times cos(latitude). Supportive and challenging totals are returned separately with every contributing line and its distance, so a strong-but-turbulent city is distinguishable from an average one. Bundled GeoNames set of 34,028 places above 15,000 people. Not geocoding: a smaller town is absent from the ranking rather than ranked poorly, and an arbitrary place name cannot be resolved.

Authorizations

• ApiKeyAuth

Request Body ^required

Media type application/json

Birth data plus a life category. Birth coordinates are optional and unused for the ranking: astrocartography lines are a property of the birth moment, not of the birth place.

object

date required

string

/^\d{4}-\d{2}-\d{2}$/

time required

string

/^\d{2}:\d{2}:\d{2}$/

timezoneOffset

number

0 nullable

latitude

number

0 nullable

longitude

number

0 nullable

houseSystem

string

default: P

name

string

""

city

string

""

zodiacType

string

Allowed values: tropical sidereal

ayanamsaId

number

nullable

cosmogram

boolean

category required

One of the 19 ACG life categories. The list is at GET /v1/acg/categories.

string

countries

ISO 3166-1 alpha-2 codes to restrict the search to. Omit to search the whole bundled list.

Array<string>

<= 50 items

minPopulation

Floor on city population. The bundled set starts at 15000, so a lower value changes nothing.

integer

>= 15000

orbKm

How far a line reaches, kilometres. Default 1126, which is the 700 miles Jim Lewis used.

number

>= 100 <= 3000

limit

How many cities to return. Default 25.

integer

>= 1 <= 100

minSeparationKm

Keep returned cities at least this far apart, kilometres. Default 300. An ACG line is a curve, so without thinning the top of the ranking is the densest stretch of one line rather than a set of places. Set 0 to disable and see every city in score order.

number

nullable <= 5000

sort

net (default) ranks on supportive minus challenging. supportive ignores the challenging side when ordering, though it is still reported.

string

Allowed values: net supportive

Example

{
  "date": "1990-05-15",
  "time": "14:30:00",
  "timezoneOffset": 3,
  "category": "career",
  "countries": [
    "UA",
    "PL"
  ],
  "orbKm": 1126,
  "limit": 25,
  "sort": "net"
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

type

string

nullable

category

object

id

string

nullable

name

string

nullable

lines

Array

nullable

orbKm

number

nullable

maxPossibleSupportive

number

nullable

pool

object

citiesConsidered

number

nullable

citiesWithAnyLine

number

nullable

minPopulation

number

nullable

count

number

nullable

places

Array<object>

nullable

object

name

string

nullable

country

string

nullable

countryCode

string

nullable

lat

number

nullable

lon

number

nullable

population

number

nullable

supportive

number

nullable

challenging

number

nullable

net

number

nullable

supportivePercent

number

nullable

lines

Array<object>

nullable

object

planetId

number

nullable

planetName

string

nullable

angle

string

nullable

weight

number

nullable

polarity

string

nullable

distanceKm

number

nullable

contribution

number

nullable

dataset

object

source

string

nullable

licence

string

nullable

note

string

nullable

attribution

object

source

string

nullable

licence

string

nullable

licenceUrl

string

nullable

Example

{
  "ok": true
}

400

Validation error

Media type application/json

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "Validation failed: date: Date must be YYYY-MM-DD",
    "details": [
      {
        "path": "date",
        "message": "Date must be YYYY-MM-DD"
      }
    ]
  }
}

401

Missing or invalid API key

Media type application/json

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key"
  }
}