Skip to content

Commit 5adce28

Browse files
committed
docs: globalize examples, front-load high-demand keywords, sync domains to 12+
Lead-with-global: the Western examples use global cities while the Vedic section keeps Indian coordinates. The README opening now front-loads the high-demand surface (natal charts, daily horoscopes, synastry, Vedic kundli, tarot spreads, human design bodygraphs, transit forecasts). Domain count reads 12+ and the breadth lists include human design and forecast.
1 parent cd1d0ef commit 5adce28

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

AGENTS.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# roxyapi/sdk - Agent Guide
22

3-
PHP SDK for RoxyAPI. 10+ domains (Western astrology, Vedic astrology, numerology, tarot, biorhythm, I Ching, crystals, dreams, angel numbers, location, usage, languages). One API key, one Composer package, zero hand-written endpoint code.
3+
PHP SDK for RoxyAPI. 12+ domains (Western astrology, Vedic astrology, numerology, tarot, human design, forecast, biorhythm, I Ching, crystals, dreams, angel numbers, location) plus utility namespaces (usage, languages). One API key, one Composer package, zero hand-written endpoint code.
44

55
## Install and initialize
66

@@ -21,15 +21,15 @@ $roxy = createRoxy(getenv('ROXY_API_KEY'));
2121
Every chart, horoscope, panchang, dasha, dosha, navamsa, KP, synastry, compatibility, and natal endpoint needs `latitude`, `longitude`, and (for Western) `timezone`. Never ask the user for coordinates. Always call `$roxy->location->searchCities` first.
2222

2323
```php
24-
$result = $roxy->location->searchCities(q: 'Mumbai');
24+
$result = $roxy->location->searchCities(q: 'New York');
2525
['latitude' => $lat, 'longitude' => $lon, 'timezone' => $tz] = $result['cities'][0];
2626

27-
// $tz is the IANA string ("Asia/Kolkata"). Pass it directly to chart calls and
27+
// $tz is the IANA string ("America/New_York"). Pass it directly to chart calls and
2828
// the server resolves it to the DST-correct offset for the chart `date`. The
2929
// decimal `utcOffset` (5.5, -5, ...) also works if you prefer numbers.
3030
```
3131

32-
`q` accepts bare city (`'Mumbai'`), city + country (`'Berlin Germany'`), or comma-qualified (`'Springfield, Illinois'`). Use the qualified form to disambiguate same-named cities.
32+
`q` accepts bare city (`'Paris'`), city + country (`'Berlin Germany'`), or comma-qualified (`'Springfield, Illinois'`). Use the qualified form to disambiguate same-named cities.
3333

3434
## Domains
3535

@@ -52,14 +52,14 @@ $result = $roxy->location->searchCities(q: 'Mumbai');
5252
| `$roxy->languages` | 1 | List the response languages accepted by the `lang` query parameter on every i18n-aware endpoint |
5353
<!-- END:DOMAINS -->
5454

55-
148 endpoints across 12 product domains plus usage and languages. Counts auto-sync from `specs/openapi.json` at release time.
55+
150+ endpoints across 12+ product domains plus usage and languages. Per-domain counts in the table above auto-sync from `specs/openapi.json` at release time.
5656

5757
## Critical patterns
5858

5959
### Two-step pattern for coordinate-dependent endpoints
6060

6161
```php
62-
$cities = $roxy->location->searchCities(q: 'Delhi');
62+
$cities = $roxy->location->searchCities(q: 'London');
6363
['latitude' => $lat, 'longitude' => $lon, 'timezone' => $tz] = $cities['cities'][0];
6464

6565
$chart = $roxy->astrology->generateNatalChart(
@@ -88,7 +88,7 @@ Body fields are named arguments on the resource method - no manual array buildin
8888
```php
8989
$roxy->astrology->generateNatalChart(
9090
date: '1990-01-15', time: '14:30:00',
91-
latitude: 28.6139, longitude: 77.2090, timezone: 5.5,
91+
latitude: 40.7128, longitude: -74.006, timezone: -5,
9292
);
9393

9494
$roxy->vedicAstrology->generateBirthChart(
@@ -145,8 +145,8 @@ try {
145145
| `timezone` | Decimal hours (number) OR IANA string | `5.5`, `-5`, `0` (decimal) OR `'Asia/Kolkata'`, `'America/New_York'` | `'5:30'`, `'+0530'`, `'GMT-5'` |
146146
| `date` | ISO date string | `'1990-01-15'` | `'Jan 15 1990'`, `'15/01/1990'`, `'1990-1-15'` |
147147
| `time` | 24-hour string with seconds | `'14:30:00'`, `'09:00:00'` | `'2:30 PM'`, `'14:30'`, `'9:0:0'` |
148-
| `latitude` | Decimal degrees (float) | `28.6139`, `-33.8688`, `40.7128` | `"28°36'N"`, strings |
149-
| `longitude` | Decimal degrees (float) | `77.2090`, `-74.0060`, `139.6917` | DMS strings |
148+
| `latitude` | Decimal degrees (float) | `51.5074`, `-33.8688`, `40.7128` | `"28°36'N"`, strings |
149+
| `longitude` | Decimal degrees (float) | `-0.1278`, `-74.0060`, `139.6917` | DMS strings |
150150
| `sign` (path) | Lowercase zodiac | `'aries'`, `'taurus'`, ... `'pisces'` | `'Aries'`, `'ARIES'`, `'1'` |
151151
| `fullName` (numerology) | Birth-certificate name | `'John William Smith'` | Nicknames, married names |
152152
| `seed` | Any string (deterministic) | `'user-42'`, `'session-abc'` | Numbers, objects |
@@ -175,7 +175,7 @@ echo json_encode($roxy->astrology->generateNatalChart(
175175
<script type="module" src="https://cdn.jsdelivr.net/npm/@roxyapi/ui@latest/dist/cdn/roxy-ui.js"></script>
176176
<roxy-natal-chart id="chart"></roxy-natal-chart>
177177
<script>
178-
fetch('/api/natal-chart.php?date=1990-01-15&time=14:30:00&lat=28.6139&lon=77.209&tz=5.5')
178+
fetch('/api/natal-chart.php?date=1990-01-15&time=14:30:00&lat=40.7128&lon=-74.006&tz=-5')
179179
.then(r => r.json())
180180
.then(data => document.getElementById('chart').data = data);
181181
</script>
@@ -205,7 +205,7 @@ See `examples/render-with-ui.html` for the full pattern. Component coverage and
205205
| Crystal by zodiac | `$roxy->crystals->getCrystalsByZodiac(sign: 'leo')` |
206206
| Dream symbol | `$roxy->dreams->getDreamSymbol(id: 'flying')` |
207207
| Angel number | `$roxy->angelNumbers->getAngelNumber(number: '1111')` |
208-
| Find city coordinates | `$roxy->location->searchCities(q: 'Mumbai')` |
208+
| Find city coordinates | `$roxy->location->searchCities(q: 'Berlin')` |
209209
| Check API usage | `$roxy->usage->getUsageStats()` |
210210
| List languages | `$roxy->languages->listLanguages()` |
211211

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[![Packagist](https://img.shields.io/packagist/v/roxyapi/sdk.svg)](https://packagist.org/packages/roxyapi/sdk)
1010
[![PHP Version](https://img.shields.io/packagist/php-v/roxyapi/sdk.svg)](https://packagist.org/packages/roxyapi/sdk)
1111

12-
Official PHP SDK for [RoxyAPI](https://roxyapi.com): Western and Vedic astrology, Human Design, forecast timelines, numerology, tarot, biorhythm, I Ching, crystals, dreams, angel numbers, location geocoding, and more. 148 endpoints across 12 domains, one API key, one dependency (Saloon).
12+
Official PHP SDK for [RoxyAPI](https://roxyapi.com): natal charts, daily horoscopes, synastry, Vedic kundli, tarot spreads, human design bodygraphs, and transit forecasts across Western and Vedic astrology, numerology, tarot, human design, forecast, biorhythm, I Ching, crystals, dreams, angel numbers, and location geocoding. 150+ endpoints across 12+ domains, one API key, one dependency (Saloon).
1313

1414
## Install
1515

@@ -34,7 +34,7 @@ $horoscope = $roxy->astrology->getDailyHoroscope(sign: 'aries');
3434
echo $horoscope['overview'], PHP_EOL;
3535

3636
// Geocode first, then chart
37-
$cities = $roxy->location->searchCities(q: 'Mumbai');
37+
$cities = $roxy->location->searchCities(q: 'London');
3838
['latitude' => $lat, 'longitude' => $lon, 'timezone' => $tz] = $cities['cities'][0];
3939

4040
$chart = $roxy->astrology->generateNatalChart(

0 commit comments

Comments
 (0)