API Documentation

Description

Beta, but stable to use.
Please reach out on our Discord if you have questions or feedback:

  • #api: for general questions/support
  • #api-users: ping Mark to get access, breaking changes will be posted here.

General information

Base URL: https://content.puhekupla.com/api/v1
Host: content.puhekupla.com/api/
Schemes: https

Authentication

An API key is required for each request. You can test our api by sending a demo API key: demo-sitename. Please replace sitename with the name of your site. API usage is currently not limited but we might introduce a limit in the future.

API usage is free, we just like to keep track of who is doing what.

  • Type: API Key (apiKey)
  • Header Name: X-Puhekupla-APIKey
  • In: header
  • How to request: Ping Mark on Discord to request your API key. Please provide your site's name when requesting. API usage is free.

Endpoints

Retrieve Latest Habbo Badges.

  • Method: GET
  • Path: /badges
  • Security: api_key
  • Produces: application/json

Query Parameters

Parameter Type Required Default Description
hotel string No - Return badges for a specific Hotel. Options: NL, ES, FI, TR, DE, FR, BR, IT, COM
page integer No 1 Current Page, use with per_page for pagination (min: 1).
per_page integer No 100 Limit the returned results (min: 1, max: 100).

Responses

  • 200 OK: Successful request.
  • 404 Not Found: No results.
  • 503 Service Unavailable: Invalid Hotel given to filter.
Examples

200 OK

[
  {
    "status_code": 200,
    "status_message": "Ok",
    "result": [
      {
        "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
        "code": "ADM",
        "name": "Hotel Staff",
        "description": "Habbo.com Staff member",
        "image": "https://content.puhekupla.com/img/badges/ADM.png?v=b031cf617c2c1d49",
        "status": "active",
        "hotel": {
          "com": {
            "name": "Name in .com Hotel",
            "description": "Description in .com Hotel"
          },
          "nl": {
            "name": "Name in .nl Hotel",
            "description": "Description in .nl Hotel"
          }
        }
      }
    ],
    "pagination": {
      "total": 100,
      "pages": 10
    }
  }
]

503 Service Unavailable:

{
  "status_code": 503,
  "status_message": "Hotel filter does not exist."
}

Retrieve Latest Habbo Furni.

  • Method: GET
  • Path: /furni
  • Security: api_key
  • Produces: application/json

Query Parameters

Parameter Type Required Default Description
page integer No 1 Current Page, use with per_page for pagination (min: 1).
per_page integer No 24 Limit the returned results (min: 1, max: 100).

Responses

  • 200 OK: Successful request.
  • 404 Not Found: No results.

Examples

200 OK

[
  {
    "status_code": 200,
    "status_message": "Ok",
    "result": {
      "category": {
        "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
        "name": "Christmas",
        "slug": "xmas",
        "image": "",
        "count": 12
      },
      "furni": [
        {
          "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
          "slug": "md_limukaappi",
          "code": "md_limukaappi",
          "name": "Habbo Cola Machine",
          "description": "A sparkling refreshing pixel drink!",
          "image": "https://content.puhekupla.com/img/furni/md_limukaappi.png?v=b031cf617c2c1d49",
          "icon": "https://content.puhekupla.com/img/furni/small_md_limukaappi.png?v=b031cf617c2c1d49",
          "status": "active"
        }
      ]
    },
    "pagination": {
      "total": 100,
      "pages": 10
    }
  }
]

Retrieve Latest Habbo Clothes.

  • Method: GET
  • Path: /clothes
  • Security: api_key
  • Produces: application/json

Query Parameters

Parameter Type Required Default Description
page integer No 1 Current Page, use with per_page for pagination (min: 1).
per_page integer No 24 Limit the returned results (min: 1, max: 100).

Responses

  • 200 OK: Successful request.
  • 404 Not Found: No results.

Examples

200 OK

[
  {
    "status_code": 200,
    "status_message": "Ok",
    "result": [
      {
        "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
        "slug": "shirt_m_edwardianblouse",
        "code": "shirt_m_edwardianblouse",
        "image": "https://content.puhekupla.com/img/clothes/shirt_M_edwardianblouse_front.png?v=b031cf617c2c1d49",
        "images": [
          "https://content.puhekupla.com/img/clothes/shirt_M_edwardianblouse_back.png?v=b031cf617c2c1d49",
          "https://content.puhekupla.com/img/clothes/shirt_M_edwardianblouse_back_left.png?v=b031cf617c2c1d49",
          "https://content.puhekupla.com/img/clothes/shirt_M_edwardianblouse_front.png?v=b031cf617c2c1d49",
          "https://content.puhekupla.com/img/clothes/shirt_M_edwardianblouse_front_right.png?v=b031cf617c2c1d49",
          "https://content.puhekupla.com/img/clothes/shirt_M_edwardianblouse_side.png?v=b031cf617c2c1d49"
        ],
        "status": "active"
      }
    ],
    "pagination": {
      "total": 100,
      "pages": 10
    }
  }
]

Retrieve Latest Puhekupla News.

Note: You'll only be able to get the excerpt of the articles. For the full message you'll need to redirect to the Puhekupla site.

  • Method: GET
  • Path: /news
  • Security: api_key
  • Produces: application/json

Query Parameters

Parameter Type Required Default Description
page integer No 1 Current Page, use with per_page for pagination (min: 1).
per_page integer No 10 Limit the returned results (min: 1, max: 10).

Responses

  • 200 OK: Successful request.
  • 404 Not Found: No results.

Example

200 OK

[
  {
    "status_code": 200,
    "status_message": "Ok",
    "result": [
      {
        "id": 0,
        "date": "2022-01-01 00:00:00",
        "modified": "2022-01-01 00:00:01",
        "recently_updated": 0,
        "slug": "happy-teletubbies-day",
        "title": "Happy Teletubbies Day! - Habbo",
        "excerpt": "<p>Happy Teletubbies Day! We&#8217;re celebrating Teletubbies Day in Habbo by dropping BRAND NEW clothing and furni! You definitely don&#8217;t want to miss out. Let&#8217;s see * These items will be available on Monday 28. TLB02 (badge) Happy Teletubbies Day! Bean Bags Plushies Headbands &amp; Hat</p>",
        "image": "https://content.puhekupla.com/uploads/2022/03/lpromo_Teletubbies_Easter22.png",
        "url": "https://puhekupla.com/news/happy-teletubbies-day"
      }
    ],
    "pagination": {
      "total": 100,
      "pages": 10
    }
  }
]