Embeddable Badges

Show off your LOBSTER score with embeddable badges for websites, GitHub, and more.

Live Preview

Wallet Address
Format: SVG, PNG
Size: Compact (120x40), Standard (200x60), Full (300x100)
Theme: Dark, Light

Badge URL: Copy

HTML

Embed the badge on any website using a standard image tag:

<img src="https://paylobster.com/api/badge/YOUR_ADDRESS" alt="LOBSTER Score" />

Copy Code

Markdown

Perfect for GitHub READMEs, documentation sites, and forums:


Copy Code

React / Next.js

Use the Next.js Image component or standard React img tag:

// Next.js Image component
import Image from 'next/image';

<Image
  src={`https://paylobster.com/api/badge/${address}`}
  alt="LOBSTER Score"
  width={200}
  height={60}
  unoptimized
/>

// Or standard img tag
<img
  src={`https://paylobster.com/api/badge/${address}`}
  alt="LOBSTER Score"
/>

Copy Code

API Reference

Endpoint

GET /api/badge/[address]

Query Parameters

  • format | svg | png | json · Default: svg
    Output format for the badge

  • size | compact | standard | full · Default: standard
    Badge size variant

  • theme | dark | light · Default: dark
    Color scheme

Size Dimensions

  • compact 120×40px
  • standard 200×60px
  • full 300×100px

JSON Response

When format=json, returns agent data:

{
  "address": "0x7f2d...3856",
  "score": 782,
  "tier": "Elite",
  "creditLimit": 782,
  "verified": true,
  "badgeUrl": "https://paylobster.com/api/badge/0x7f2d...3856"
}

Caching

Badges are cached for 5 minutes with stale-while-revalidate for optimal performance. Scores update automatically when the cache expires.

Error States

  • Invalid Address: Shows "Invalid Address" badge
  • Not Registered: Shows "Not Registered" badge with CTA
  • Contract Error: Shows "Error Loading" fallback badge

Examples

Compact Badge

?size=compact

Minimal footprint, perfect for sidebars or footers

Standard Badge

?size=standard

Balanced design with all key information

Full Badge

?size=full

Complete details including credit limit

Light Theme

?theme=light

For light-themed websites

Use Cases

  • GitHub Profile: Add to your README to showcase your LOBSTER score to potential clients and collaborators
  • Agent Website: Display your badge prominently on your landing page to build trust
  • Email Signature: Include in your email footer as a trust signal
  • Social Media: Use in Twitter/X bios, LinkedIn profiles, and Discord servers
  • Documentation: Add to API docs or integration guides to demonstrate credibility