Best Names by Sign

POST

/pet/best-names

• Production

Sign-aligned name suggestions; optional gender filter.

Authorizations

• ApiKeyAuth

Code Samples

cURL

curl -X POST https://api.astroway.info/v1/pet/best-names \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "date": "2020-06-15", "time": "12:00:00", "timezoneOffset": 0, "latitude": 40, "longitude": -74, "gender": "feminine" }'

Node.js

const res = await fetch('https://api.astroway.info/v1/pet/best-names', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "date": "2020-06-15",
    "time": "12:00:00",
    "timezoneOffset": 0,
    "latitude": 40,
    "longitude": -74,
    "gender": "feminine"
  }),
});
const { ok, data, error } = await res.json();
if (!ok) throw new Error(error.message);
console.log(data);

Python

import os, requests

r = requests.post(
    'https://api.astroway.info/v1/pet/best-names',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
    json={
      'date': "2020-06-15",
      'time': "12:00:00",
      'timezoneOffset': 0,
      'latitude': 40,
      'longitude': -74,
      'gender': "feminine"
    },
)
result = r.json()
if not result['ok']:
    raise RuntimeError(result['error']['message'])
print(result['data'])

PHP

<?php
use GuzzleHttp\Client;

$client = new Client(['base_uri' => 'https://api.astroway.info/v1/']);
$r = $client->post('pet/best-names', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
    'json' => [
        'date' => '2020-06-15',
        'time' => '12:00:00',
        'timezoneOffset' => 0,
        'latitude' => 40,
        'longitude' => -74,
        'gender' => 'feminine',
    ],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

Request Body ^required

object

Example

{
  "date": "2020-06-15",
  "time": "12:00:00",
  "timezoneOffset": 0,
  "latitude": 40,
  "longitude": -74,
  "gender": "feminine"
}

Responses

200

Successful calculation

object

ok

boolean

Example

true

data

object

names

Array

400

Validation error

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

Example

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