EU-Utility/docs/NEXUS_LINKTREE.md

259 lines
7.3 KiB
Markdown

# Entropia Nexus LinkTree
> Complete reference of all Entropia Nexus URLs and endpoints
>
> **Last Updated:** 2025-02-13
---
## Base URLs
| URL | Purpose |
|-----|---------|
| `https://api.entropianexus.com` | **Primary API Endpoint** - REST API for programmatic access |
| `https://www.entropianexus.com` | **Web Interface** - Main website for browsing |
---
## API Endpoints (api.entropianexus.com)
### Search & Discovery
| Endpoint | Method | Description |
|----------|--------|-------------|
| `/search` | GET | Universal search across all entity types |
| `/search?q={query}&limit={n}` | GET | Search with query and result limit |
| `/search?fuzzy=true` | GET | Fuzzy matching search |
### Entity Endpoints
All entity types support: `GET /{entity-type}` and `GET /{entity-type}?q={query}`
| Endpoint | Entity Type | Description |
|----------|-------------|-------------|
| `/items` | Items | General items, tools, components |
| `/weapons` | Weapons | Guns, melee, mining tools |
| `/armors` | Armors | Protective gear sets |
| `/blueprints` | Blueprints | Crafting recipes |
| `/mobs` | Mobs | Creatures, NPCs |
| `/locations` | Locations | Points of interest |
| `/skills` | Skills | Player skills & professions |
| `/materials` | Materials | Ores, enmatters, components |
| `/enhancers` | Enhancers | Weapon/armor enhancers |
| `/medicaltools` | Medical Tools | Healing tools, FAPs |
| `/finders` | Finders | Mining finders/detectors |
| `/excavators` | Excavators | Mining excavators |
| `/refiners` | Refiners | Resource refiners |
| `/vehicles` | Vehicles | Ships, vehicles, mounts |
| `/pets` | Pets | Tameable creatures |
| `/decorations` | Decorations | Estate decorations |
| `/furniture` | Furniture | Estate furniture |
| `/storagecontainers` | Storage | Storage boxes, containers |
| `/strongboxes` | Strongboxes | Loot boxes |
| `/teleporters` | Teleporters | TP locations |
| `/shops` | Shops | Player shops |
| `/vendors` | Vendors | NPC vendors |
| `/planets` | Planets | Planet information |
| `/areas` | Areas | Geographic regions |
### Item-Specific Endpoints
| Endpoint | Description |
|----------|-------------|
| `/items/{id}` | Get specific item details |
| `/items/{id}/market` | Get market data for item |
### Market Data (www.entropianexus.com)
| Endpoint | Description |
|----------|-------------|
| `/api/market/exchange` | Exchange/auction listings |
| `/api/market/prices/latest?items={ids}` | Latest prices for items |
### User Data (www.entropianexus.com)
| Endpoint | Description |
|----------|-------------|
| `/api/users/search?q={query}` | Search verified users |
---
## Web Pages (www.entropianexus.com)
### Main Sections
| URL | Description |
|-----|-------------|
| `/` | Home page |
| `/market/exchange` | Exchange market browser |
| `/market/history` | Price history charts |
| `/items` | Item database browser |
| `/mobs` | Creature database |
| `/locations` | Location database |
| `/skills` | Skill information |
| `/blueprints` | Blueprint database |
| `/tools` | Utility tools |
| `/about` | About Nexus |
### Entity Detail Pages
| URL Pattern | Description |
|-------------|-------------|
| `/items/{item-id}` | Item detail page |
| `/mobs/{mob-id}` | Mob detail page |
| `/locations/{loc-id}` | Location detail page |
| `/skills/{skill-id}` | Skill detail page |
| `/blueprints/{bp-id}` | Blueprint detail page |
| `/users/{user-id}` | User profile page |
---
## Resources & Assets
### Image Assets
| Pattern | Description |
|---------|-------------|
| `/icons/{item-id}.png` | Item icons |
| `/images/mobs/{mob-id}.png` | Mob images |
| `/images/locations/{loc-id}.png` | Location images |
### Data Downloads
| URL | Description |
|-----|-------------|
| `/api/export/items` | Full item database export |
| `/api/export/blueprints` | Full blueprint export |
---
## Entity Type Mapping
### API Endpoint → Web Path Mapping
When converting API entities to web URLs:
| API Entity Type | Web Path | Notes |
|-----------------|----------|-------|
| Items | `/items/{id}` | All item subtypes use `/items/` |
| Weapons | `/items/{id}` | Weapons are items |
| Armors | `/items/{id}` | Armors are items |
| Blueprints | `/blueprints/{id}` | Separate section |
| Mobs | `/mobs/{id}` | Separate section |
| Locations | `/locations/{id}` | Includes TPs, shops |
| Skills | `/skills/{id}` | Separate section |
| Materials | `/items/{id}` | Materials are items |
| Enhancers | `/items/{id}` | Enhancers are items |
| Medical Tools | `/items/{id}` | Medical tools are items |
| Finders | `/items/{id}` | Finders are items |
| Excavators | `/items/{id}` | Excavators are items |
| Refiners | `/items/{id}` | Refiners are items |
| Vehicles | `/items/{id}` | Vehicles are items |
| Pets | `/items/{id}` | Pets are items |
| Decorations | `/items/{id}` | Decorations are items |
| Furniture | `/items/{id}` | Furniture are items |
| Storage | `/items/{id}` | Storage are items |
| Strongboxes | `/items/{id}` | Strongboxes are items |
| Teleporters | `/locations/{id}` | TPs are locations |
| Shops | `/locations/{id}` | Shops are locations |
| Vendors | `/locations/{id}` | Vendors are locations |
| Planets | `/locations/{id}` | Planets are locations |
| Areas | `/locations/{id}` | Areas are locations |
---
## Query Parameters Reference
### Common Parameters
| Parameter | Type | Description | Example |
|-----------|------|-------------|---------|
| `q` | string | Search query | `q=ArMatrix` |
| `query` | string | Alternative search parameter | `query=ArMatrix` |
| `limit` | integer | Max results (default: 20, max: 100) | `limit=50` |
| `fuzzy` | boolean | Enable fuzzy matching | `fuzzy=true` |
| `type` | string | Filter by entity type | `type=item` |
### Advanced Parameters
| Parameter | Description |
|-----------|-------------|
| `category` | Filter by item category |
| `min_level` | Minimum item level |
| `max_level` | Maximum item level |
| `planet` | Filter by planet |
---
## Rate Limits
| Endpoint | Limit |
|----------|-------|
| General API | 5 requests/second |
| Search | 10 requests/minute |
| Market Data | 60 requests/minute |
---
## Response Formats
### Standard Search Response
```json
[
{
"id": "item-id",
"name": "Item Name",
"type": "item",
"category": "Weapon",
"icon_url": "https://..."
}
]
```
### Standard Item Detail Response
```json
{
"id": "item-id",
"name": "Item Name",
"description": "Item description...",
"category": "Weapon",
"weight": 2.5,
"tt_value": 120.0,
"decay": 0.5,
"damage": 45.0,
"range": 45.0,
"accuracy": 80.0,
"durability": 10000
}
```
---
## Related Documentation
- [NEXUS_API_REFERENCE.md](./NEXUS_API_REFERENCE.md) - Complete API documentation
- [Plugin API Integration](../core/plugin_api.py) - How plugins access Nexus API
- [Nexus API Client](../core/nexus_api.py) - Core API client implementation
---
## External Links
- **Main Website:** https://www.entropianexus.com
- **API Base:** https://api.entropianexus.com
- **Discord:** Check Nexus website for community links
- **Forums:** Entropia Universe official forums
---
## Notes
- API and web URLs are separate domains (`api.` vs `www.`)
- Some endpoints return different field name formats:
- API may return `name` or `Name` (camelCase vs PascalCase)
- Always check both when parsing responses
- Market data endpoints are on `www.` subdomain
- Search endpoints support fuzzy matching for typo tolerance