api.socialfetch.dev

{
  "description": "Standard success response envelope.",
  "properties": {
    "data": {
      "description": "Endpoint-specific response payload.",
      "properties": {
        "developers": {
          "description": "Ranked trending developers for the selected filters. Each entry may include a popularRepository when GitHub shows one.",
          "items": {
            "description": "Developer entry from GitHub trending.",
            "properties": {
              "avatarUrl": {
                "description": "Avatar image URL when available.",
                "nullable": true,
                "type": "string"
              },
              "displayName": {
                "description": "Display name when available.",
                "nullable": true,
                "type": "string"
              },
              "handle": {
                "description": "GitHub username.",
                "type": "string"
              },
              "popularRepository": {
                "description": "Popular repository GitHub highlights for this developer.",
                "nullable": true,
                "properties": {
                  "description": {
                    "description": "Repository description when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "fullName": {
                    "description": "Full repository name in `owner/repo` form.",
                    "type": "string"
                  },
                  "name": {
                    "description": "Display name for the popular repository when shown.",
                    "type": "string"
                  },
                  "owner": {
                    "description": "Popular repository owner login.",
                    "type": "string"
                  },
                  "repo": {
                    "description": "Popular repository name.",
                    "type": "string"
                  },
                  "url": {
                    "description": "Canonical public repository URL.",
                    "minLength": 1,
                    "type": "string"
                  }
                },
                "required": [
                  "owner",
                  "repo",
                  "fullName",
                  "url",
                  "name",
                  "description"
                ],
                "type": "object"
              },
              "profileUrl": {
                "description": "Canonical public GitHub profile URL.",
                "minLength": 1,
                "type": "string"
              },
              "rank": {
                "description": "Position on the trending developers page.",
                "exclusiveMinimum": true,
                "minimum": 0,
                "type": "integer"
              }
            },
            "required": [
              "rank",
              "handle",
              "displayName",
              "profileUrl",
              "avatarUrl",
              "popularRepository"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "language": {
          "description": "Coding language filter applied to this response, or null when all languages are included.",
          "nullable": true,
          "type": "string"
        },
        "since": {
          "description": "Trending time window applied to this response.",
          "enum": [
            "daily",
            "weekly",
            "monthly"
          ],
          "type": "string"
        },
        "totalResults": {
          "description": "Number of developers in `data.developers` for this response.",
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "since",
        "language",
        "developers",
        "totalResults"
      ],
      "type": "object"
    },
    "meta": {
      "description": "Metadata describing the request and billing outcome.",
      "properties": {
        "cached": {
          "description": "True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present.",
          "type": "boolean"
        },
        "creditsCharged": {
          "description": "Credits charged for this request.",
          "minimum": 0,
          "type": "integer"
        },
        "requestId": {
          "description": "Unique request identifier for tracing this API call.",
          "minLength": 1,
          "type": "string"
        },
        "version": {
          "description": "Public API version that served the response.",
          "enum": [
            "v1"
          ],
          "type": "string"
        }
      },
      "required": [
        "requestId",
        "creditsCharged",
        "version"
      ],
      "type": "object"
    }
  },
  "required": [
    "data",
    "meta"
  ],
  "type": "object"
}