Référence Développeur

Disponibilité des Identifiants de Réseaux Sociaux Documentation de l'API

Disponibilité des Identifiants de Réseaux Sociaux Documentation de l'API: Vérifiez si un nom d'utilisateur est disponible sur les principaux réseaux sociaux.

Disponibilité des Identifiants de Réseaux Sociaux

Vérifiez si un nom d'utilisateur est disponible sur les principaux réseaux sociaux.

GET /v1/social

Paramètres de Requête

Paramètre	Type	Description
handle requis	string	Nom d'utilisateur/identifiant à vérifier
platforms	string	Liste des plateformes a verifier, separees par des virgules (par defaut : toutes les plateformes prises en charge)

Exemple de Réponse

{
                "handle": "mycompany",
                "availability": {
                "github": { "available": false, "profile_url": "https://github.com/mycompany", "checked": true, "requested": true, "method": "official_api", "confidence": "high" },
                "reddit": { "available": true, "profile_url": null, "checked": true, "requested": true, "method": "public_endpoint", "confidence": "high" },
                "youtube": { "available": true, "profile_url": null, "checked": true, "requested": true, "method": "public_profile", "confidence": "high" }
                },
                "summary": {
                "available_count": 2,
                "unavailable_count": 1,
                "unknown_count": 0
                },
                "summary_v2": {
                "requested_count": 3,
                "checked_count": 3,
                "available_count": 2,
                "unavailable_count": 1,
                "unknown_count": 0,
                "not_supported_count": 0,
                "determinacy_rate": 1
                }
                }

Champs de Réponse

Champ	Type
`handle`	string
`checked_at`	string
`availability`	object
`summary`	object
`summary.available_count`	integer
`summary.unavailable_count`	integer
`summary.unknown_count`	integer
`summary_v2`	object
`summary_v2.requested_count`	integer
`summary_v2.checked_count`	integer
`summary_v2.available_count`	integer
`summary_v2.unavailable_count`	integer
`summary_v2.unknown_count`	integer
`summary_v2.not_supported_count`	integer
`summary_v2.determinacy_rate`	number
`beta_notice`	string
`meta`	object
`meta.supported_platforms[]`	string[]
`meta.unsupported_platforms[]`	string[]
`meta.latency_ms`	integer

GET /v1/social/info

Champs de Réponse

Champ	Type
`endpoint`	string
`description`	string
`parameters`	object
`platforms`	object
`platforms.supported[]`	string[]
`platforms.coming_soon[]`	string[]
`platforms.experimental[]`	string[]
`platforms.planned[]`	string[]
`platforms.blocked[]`	string[]
`platforms.details[]`	object[]
`platforms.details[]`	object
`platforms.details[].id`	string
`platforms.details[].display_name`	string
`platforms.details[].aliases[]`	string[]
`platforms.details[].category`	string
`platforms.details[].tier`	integer
`platforms.details[].status`	string
`platforms.details[].method`	string
`platforms.details[].confidence`	string
`platforms.details[].logo_key`	string
`platforms.details[].profile_url_template`	string \| null
`platforms.details[].docs_anchor`	string
`platforms.details[].caveat_codes[]`	string[]
`platforms.details[].cache_ttl_s`	object
`platforms.details[].cache_ttl_s.available`	integer
`platforms.details[].cache_ttl_s.taken`	integer
`platforms.details[].cache_ttl_s.unknown`	integer
`platforms.details[].cache_ttl_s.rate_limited`	integer
`platforms.details[].handle_rules`	object
`platforms.details[].handle_rules.min_length`	integer
`platforms.details[].handle_rules.max_length`	integer
`platforms.details[].handle_rules.description`	string
`example_request`	string
`example_response`	object

Exemple de Requête

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/social/info"

Exemple de Réponse

{
  "endpoint": "/v1/social",
  "description": "Check if a username is available on supported social platforms.",
  "parameters": {
    "handle": {
      "type": "string",
      "required": true,
      "description": "Username to check"
    },
    "platforms": {
      "type": "string",
      "required": false,
      "description": "Comma-separated platform list",
      "example": "github,gitlab,reddit"
    }
  },
  "platforms": {
    "supported": [
      "github",
      "gitlab",
      "bitbucket",
      "devto",
      "huggingface",
      "dribbble",
      "soundcloud",
      "gumroad",
      "buymeacoffee",
      "substack",
      "itchio",
      "hackernews",
      "reddit",
      "bluesky",
      "twitter",
      "instagram",
      "facebook",
      "threads",
      "pinterest",
      "snapchat",
      "telegram",
      "twitch",
      "patreon",
      "tiktok",
      "youtube",
      "linkedin"
    ],
    "coming_soon": [
      "behance",
      "dockerhub",
      "hashnode",
      "rubygems",
      "discord"
    ],
    "experimental": [
      "behance",
      "dockerhub",
      "hashnode",
      "rubygems"
    ],
    "planned": [],
    "blocked": [
      "discord"
    ],
    "details": [
      {
        "id": "github",
        "display_name": "GitHub",
        "aliases": [
          "github"
        ],
        "category": "developer",
        "tier": 0,
        "status": "live",
        "method": "official_api",
        "confidence": "high",
        "logo_key": "github",
        "profile_url_template": "https://github.com/{handle}",
        "docs_anchor": "github",
        "caveat_codes": [],
        "cache_ttl_s": {
          "available": 300,
          "taken": 3600,
          "unknown": 60,
          "rate_limited": 60
        },
        "handle_rules": {
          "min_length": 1,
          "max_length": 39,
          "description": "1-39 chars, alphanumeric and hyphens, cannot start/end with hyphen"
        }
      }
    ]
  },
  "example_request": "/v1/social?handle=myusername&platforms=github,gitlab,reddit",
  "example_response": {
    "handle": "myusername",
    "checked_at": "2025-01-05T12:00:00Z",
    "availability": {
      "github": {
        "available": true,
        "profile_url": null,
        "checked": true,
        "requested": true
      },
      "reddit": {
        "available": false,
        "profile_url": "https://reddit.com/user/myusername",
        "checked": true,
        "requested": true
      },
      "gitlab": {
        "available": true,
        "profile_url": null,
        "checked": true,
        "requested": true
      }
    },
    "summary": {
      "available_count": 2,
      "unavailable_count": 1,
      "unknown_count": 0
    },
    "summary_v2": {
      "requested_count": 3,
      "checked_count": 3,
      "available_count": 2,
      "unavailable_count": 1,
      "unknown_count": 0,
      "not_supported_count": 0,
      "determinacy_rate": 1
    }
  }
}