BXWY Logo
Back to the Business Page

Connect the API, Show your Badge

Plug and Play the API and get implementation code for your platform. Choose your format, language, and badge dimension.

Try It Yourself

Select any platform, choose your preferred format and badge dimensions, then copy the code to embed on your website.

No badges available yet to preview

How to Implement the API?

1. Use the API tester above to generate your embed code

1.1 Select your platform

Choose your company from the dropdown list. Your company not visible?

1.2 Choose your format

Pick between HTML, React, or direct API format based on your implementation needs.

1.3 elect language

Choose from English, Nederlands, Deutsch, Español, or Français for your badge text.

1.4 Pick badge dimensions

Select 16:9 (landscape), 1:1 (square), or 5:1 (ultra wide) based on where you'll display it.

* The tool generates ready-to-use code that you can copy with one click.

2. Paste the code into your website

Add the generated HTML/React code to your website where you want the badge to appear, typically in your header, footer, or about page. The badge automatically links back to your BuyXWithY profile.

3. Badge updates automatically every 24 hours

As customers vote on your strengths, your badge updates daily (00:00:00 UTC+1) to reflect your top competitive advantage. No code changes needed, the API serves the latest badge data automatically.

Test the Badge API Like a Customer

Try our comprehensive test environment to see live API responses, test all badge variations, and verify integration code before going live.

Open Test Environment

API Reference

Our badge API provides two endpoints: (1) one returns your platform's badge data as JSON (for custom implementations), and another (2) delivers a ready-to-use SVG image badge. Both are completely open and require no authentication, simply use your platform's URL slug to access your badge data or image instantly.

1. Get Badge Data

GET https://www.buyxwithy.com/api/badges/[platform-slug]

Returns JSON data about a platform's badge, including badge type, vote count, and percentage.

// Example Response
{
  "success": true,
  "platform": {
    "slug": "kraken",
    "name": "Kraken"
  },
  "badge": {
    "type": "Best Security",
    "voteCount": 342,
    "percentage": 67.5,
    "totalVotes": 506,
    "lastUpdated": "2025-10-25T12:00:00Z"
  }
}

2. Get Badge Embed

GET https://www.buyxwithy.com/api/badges/[platform-slug]/embed

Returns an embeddable badge (SVG) that you can display on your website.

Query Parameters:

  • format - Badge format (svg, html, json)
  • lang - Language code (en, nl, de, es, fr)
  • dimension - Badge aspect ratio (16:9, 1:1, 5:1)

Badge Dimensions

16:9 - Landscape
Best for sidebars and footers
16:9 badge example
1:1 - Square
Perfect for sidebars and footers
1:1 badge example
5:1 - Ultra Wide
Ideal for wide placements
5:1 badge example

Supported Languages

EN
English
NL
Nederlands
DE
Deutsch
ES
Español
FR
Français

Ready to Get Started?

Join the partnership program and start showcasing your competitive advantage.

Sign Up for Partner Program