@extends('layouts.app') @section('title', 'API Documentation') @section('active', 'docs') @section('content')
Developer hub

Build faster with clear APIs.

Everything you need to authenticate, send your first request and ship with confidence.

Live reference Updated continuously
01
Connect to an API

Send your API key in the request header and pass only API parameters in the URL.

Get free key
GET{{ url('/api') }}/{service}?param=value
Recommended: send your key in X-API-KEY or Authorization: Bearer …. Query-string keys remain supported for older clients, but URLs can be recorded in browser history and server access logs.
{service} — API slug from the URL below
X-API-KEY — send your key in the request header
params — API parameters listed below
Rate limit: {{ (int) $rateLimit }} requests/minute per key • {{ (int) setting('api_ip_rate_limit',120) }} req/min per IP • Credit cost shown per API.
@if($services->isEmpty())
No APIs published yetPlease check back soon.
@else
@foreach($services as $s) @php $myApiKey = 'YOUR_API_KEY'; @endphp
{{ $s->name }}

{{ $s->description }}

@if($s->useCaseList())
What this API can do
    @foreach($s->useCaseList() as $use)
  • {{ $use }}
  • @endforeach
@endif
{{ (int) $s->credits_per_hit }} credit/hit {{ strtoupper($s->method) }} {{ (int) setting('api_rate_limit',60) }}/min per key ~{{ $s->liveStats()['avg_ms'] }}ms avg Active Get Key & Pricing →
Authentication: use the X-API-KEY header. Query-string keys are still accepted for compatibility but are not recommended because URLs may be logged. This page never displays account-specific keys.
@php $pq = []; foreach ($s->paramList() as $p) { $sm = $s->exampleParams()[$p['name']] ?? $p['placeholder'] ?? ''; $pq[] = $p['name'].'='.urlencode(($sm === '' || strlen($sm) > 24) ? '123456' : $sm); } $fullUrl = $s->gatewayUrl().($pq ? '?'.implode('&', $pq) : ''); $isPost = strtoupper($s->method) === 'POST'; @endphp
{{ strtoupper($s->method) }}{{ $fullUrl }}
@if(count($s->paramList())) Parameters
@foreach($s->paramList() as $p) @endforeach
NameTypeRequiredExampleDescription
{{ $p['name'] }} string {!! !empty($p['required']) ? badge('yes', 'primary') : badge('optional', 'info') !!} {{ $s->exampleParams()[$p['name']] ?? $p['placeholder'] ?? '—' }} {{ $p['label'] ?? '—' }}
@endif @if($s->docsMarkdown())
{!! nl2br(e($s->docsMarkdown())) !!}
@endif @if($s->sample_response) @endif {{-- Code samples – uses logged-in key if available, else placeholder --}} @include('partials.code-samples', ['service' => $s, '__apiKey' => $myApiKey])
Documentation only. Use the request samples above with your own credential in your application. Account keys and live request forms are intentionally kept out of this documentation page.
@endforeach
@endif
@push('scripts') @endpush @endsection