Skip to main content

Get Platform by Homepage URL

This endpoint retrieves platform information using its homepage URL.

Deprecation Notice

This endpoint will be deprecated soon. Consider using alternative platform lookup methods.

Endpoint​

GET /api/platform/homepage/:url

Authentication​

No authentication required. This endpoint is publicly accessible.

Parameters​

Path Parameters​

ParameterTypeRequiredDescription
urlstringYesThe homepage URL of the platform to retrieve

Response​

Success Response​

Code: 200 OK

Content Example:

{
"id": 10,
"name": "100x",
"slug": "100x",
"description": null,
"upgradeBtn": null,
"heroImage": null,
"favIconImage": null,
"heroBGColor": null,
"heroTextColor": null,
"primaryColor": null,
"secondaryColor": null,
"darkColor": null,
"lightColor": null,
"heroImgOnly": false,
"fathomAnalytics": null,
"homepageUrl": "100x.com",
"upgradeUrl": "100x.com/upgrade",
"logo": "1602032429041-platform-logo.png",
"premiumToken": null,
"basicToken": null,
"hideSignin": null,
"timezone": "US/Eastern",
"createdAt": "2020-10-02T08:15:17.000Z",
"updatedAt": "2020-10-07T01:00:31.000Z"
}

Error Response​

Condition: If the platform with the specified homepage URL does not exist or another error occurs.

Code: 400 Bad Request

Content: {error}

Notes​

  • This endpoint is useful for retrieving platform information when only the homepage URL is known.
  • The URL parameter should be provided without the protocol (http:// or https://).
  • This endpoint will be deprecated in a future API version.
  • Consider using platform ID or slug for more reliable platform identification.

Example​

curl -X GET "https://api.tribesocial.io/api/platform/homepage/100x.com" \
-H "Content-Type: application/json"