{ "openapi": "3.1.0", "info": { "title": "Bridgly API", "description": "Web scraping API for LinkedIn, X (Twitter), Reddit, GitHub, Instagram and TikTok. Authenticated endpoints accept a Bridgly API key (`bgly_…`) via `Authorization: Bearer `.", "version": "1.0.0" }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "A Bridgly API key (`bgly_…`). Metered endpoints deduct credits from the resolved account." } }, "schemas": {} }, "paths": { "/linkedin/get-company-from-url": { "post": { "summary": "Fetch a LinkedIn company by company slug", "tags": [ "LinkedIn" ], "description": "Get a LinkedIn company page from the slug in its URL, e.g. \"openai\". Returns the name, tagline, description, industry, employee count, headquarters and other locations, website, follower count, specialties, funding details and similar companies. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "universalName": { "type": "string", "pattern": "^[^\\s/?#&=]+$", "description": "The company's LinkedIn universal name — the slug in linkedin.com/company/, e.g. \"openai\"." } }, "required": [ "universalName" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "universalName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "foundedYear": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "staffCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "staffCountRange": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "specialties": { "type": "array", "items": { "type": "string" } }, "headquarters": { "anyOf": [ { "type": "object", "properties": { "line1": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "geographicArea": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "headquarter": { "type": "boolean" } }, "required": [ "line1", "city", "geographicArea", "postalCode", "country", "headquarter" ], "additionalProperties": false }, { "type": "null" } ] }, "confirmedLocations": { "type": "array", "items": { "type": "object", "properties": { "line1": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "geographicArea": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "headquarter": { "type": "boolean" } }, "required": [ "line1", "city", "geographicArea", "postalCode", "country", "headquarter" ], "additionalProperties": false } }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "linkedinUrl": { "type": "string" }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tagline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "affiliatedCompanyIds": { "type": "array", "items": { "type": "string" } }, "showcasePageIds": { "type": "array", "items": { "type": "string" } }, "fundingData": { "anyOf": [ { "type": "object", "properties": { "numFundingRounds": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastFundingRound": { "anyOf": [ { "type": "object", "properties": { "fundingType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "moneyRaised": { "anyOf": [ { "type": "object", "properties": { "currencyCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "currencyCode", "amount" ], "additionalProperties": false }, { "type": "null" } ] }, "announcedOn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "leadInvestors": { "type": "array", "items": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "crunchbaseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "crunchbaseUrl" ], "additionalProperties": false } }, "numOtherInvestors": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "crunchbaseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "fundingType", "moneyRaised", "announcedOn", "leadInvestors", "numOtherInvestors", "crunchbaseUrl" ], "additionalProperties": false }, { "type": "null" } ] }, "companyCrunchbaseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "numFundingRounds", "lastFundingRound", "companyCrunchbaseUrl" ], "additionalProperties": false }, { "type": "null" } ] }, "similarCompanies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "description", "logoUrl", "url", "industry" ], "additionalProperties": false } } }, "required": [ "name", "universalName", "description", "website", "industry", "companyType", "foundedYear", "staffCount", "staffCountRange", "specialties", "headquarters", "confirmedLocations", "logoUrl", "bannerUrl", "linkedinUrl", "followerCount", "tagline", "affiliatedCompanyIds", "showcasePageIds", "fundingData", "similarCompanies" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.getCompanyFromUrl({\n universalName: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/get-profile-from-url": { "post": { "summary": "Fetch a LinkedIn profile by profile slug", "tags": [ "LinkedIn" ], "description": "Get a LinkedIn profile from the slug in its URL, e.g. \"williamhgates\". Returns the name, headline, location, about section, full work history, education, skills, certifications, languages, projects and more. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "memberIdentity": { "type": "string", "pattern": "^[^\\s/?#&=]+$", "description": "The member's public identity — the slug in linkedin.com/in/, e.g. \"williamhgates\"." } }, "required": [ "memberIdentity" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "headline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profilePhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bannerPhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "about": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profileUrl": { "type": "string" }, "openToWork": { "type": "boolean" }, "hiring": { "type": "boolean" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "experience": { "type": "array", "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyLogoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employmentType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "industries": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "company", "companyId", "companyUrl", "companyLogoUrl", "employmentType", "location", "startDate", "endDate", "description", "industries" ], "additionalProperties": false } }, "education": { "type": "array", "items": { "type": "object", "properties": { "school": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "schoolId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "schoolUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "schoolLogoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "degree": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fieldOfStudy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "activities": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "school", "schoolId", "schoolUrl", "schoolLogoUrl", "degree", "fieldOfStudy", "startDate", "endDate", "grade", "activities", "description" ], "additionalProperties": false } }, "volunteering": { "type": "array", "items": { "type": "object", "properties": { "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "organization": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cause": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "organization", "cause", "startDate", "endDate", "description" ], "additionalProperties": false } }, "certifications": { "type": "array", "items": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "issuingOrganization": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expirationDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "credentialId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "credentialUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "issuingOrganization", "issueDate", "expirationDate", "credentialId", "credentialUrl" ], "additionalProperties": false } }, "skills": { "type": "array", "items": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "endorsements": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "endorsements" ], "additionalProperties": false } }, "languages": { "type": "array", "items": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "proficiency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "proficiency" ], "additionalProperties": false } }, "publications": { "type": "array", "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publisher": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publishDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "publisher", "publishDate", "description", "url" ], "additionalProperties": false } }, "patents": { "type": "array", "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "patentOffice": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "patentNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "patentOffice", "patentNumber", "issueDate", "description" ], "additionalProperties": false } }, "courses": { "type": "array", "items": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "number" ], "additionalProperties": false } }, "projects": { "type": "array", "items": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "startDate", "endDate", "description", "url" ], "additionalProperties": false } }, "honorsAndAwards": { "type": "array", "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "issuer": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "issueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "issuer", "issueDate", "description" ], "additionalProperties": false } }, "birthday": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "headline", "location", "profilePhotoUrl", "bannerPhotoUrl", "about", "profileUrl", "openToWork", "hiring", "industry", "experience", "education", "volunteering", "certifications", "skills", "languages", "publications", "patents", "courses", "projects", "honorsAndAwards", "birthday", "address" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.getProfileFromUrl({\n memberIdentity: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/get-job": { "post": { "summary": "Fetch a LinkedIn job posting by URL", "tags": [ "LinkedIn" ], "description": "Get a LinkedIn job posting from its URL. Returns the title, full description, company, location, remote option, experience level, employment type, application link, posting and expiry dates, and applicant and view counts. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "jobUrl": { "type": "string", "pattern": "\\/view\\/(?:[^/?#]*-)?(\\d+)", "description": "The LinkedIn job posting URL — the numeric job id is parsed from it, e.g. \"https://www.linkedin.com/jobs/view/4417164255/\"." } }, "required": [ "jobUrl" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "jobId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric job id parsed from the URL, e.g. \"4417164255\"." }, "jobUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Job posting URN, e.g. \"urn:li:fs_normalized_jobPosting:\"." }, "dashJobUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Newer \"dash\" job posting URN, e.g. \"urn:li:fsd_jobPosting:\"." }, "jobUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical job posting URL, e.g. \"https://www.linkedin.com/jobs/view//\"." }, "applyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Offsite application URL when the posting applies on the employer site." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Job title." }, "standardizedTitleUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Standardized title URN, e.g. \"urn:li:fs_title:5115\"." }, "standardizedTitleId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric standardized title id parsed from the title URN." }, "standardizedTitleName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Standardized title label, e.g. \"Undergraduate Student\"." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full job description as plain text." }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Formatted job location, e.g. \"San Francisco, CA\"." }, "geoUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Location geo URN, e.g. \"urn:li:fs_geo:106411676\"." }, "geoId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric geo id parsed from the location URN." }, "countryUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Country URN, e.g. \"urn:li:fs_country:us\"." }, "countryCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO country code parsed from the country URN, e.g. \"us\"." }, "workRemoteAllowed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the posting permits fully-remote work." }, "experienceLevel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Formatted experience level, e.g. \"Entry level\", when exposed." }, "employmentType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Employment type label, e.g. \"Full-time\"." }, "employmentTypeUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Employment status URN, e.g. \"urn:li:fs_employmentStatus:FULL_TIME\"." }, "employmentTypeCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Employment status code parsed from the URN, e.g. \"FULL_TIME\"." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industryId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric LinkedIn industry id, e.g. \"70\"." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Industry display name, e.g. \"Research Services\"." } }, "required": [ "industryId", "name" ], "additionalProperties": false }, "description": "Industries this posting is classified under, with stable ids." }, "jobFunctions": { "type": "array", "items": { "type": "object", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "LinkedIn job-function code, e.g. \"EDU\"." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Job-function display name, e.g. \"Education\"." } }, "required": [ "code", "name" ], "additionalProperties": false }, "description": "Job functions for the posting, with their codes." }, "inferredBenefits": { "type": "array", "items": { "type": "string" }, "description": "Benefits inferred from the posting, e.g. \"401(k)\"." }, "jobState": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Posting lifecycle state, e.g. \"LISTED\" or \"CLOSED\"." }, "sourceDomain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Employer domain the posting originated from, e.g. \"lanl.jobs\"." }, "listedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Listing date in ISO-8601 (UTC), from the posting's listedAt." }, "listedAtEpochMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Listing date as a Unix epoch in milliseconds." }, "originalListedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Original listing date in ISO-8601 (UTC), if re-posted." }, "originalListedAtEpochMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Original listing date as a Unix epoch in milliseconds." }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Expiry date in ISO-8601 (UTC), when the posting closes." }, "expiresAtEpochMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Expiry date as a Unix epoch in milliseconds." }, "closedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Close date in ISO-8601 (UTC) once the posting is closed." }, "closedAtEpochMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Close date as a Unix epoch in milliseconds." }, "applies": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of applications submitted, when exposed." }, "views": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the posting has been viewed, when exposed." }, "companyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hiring company name." }, "companyUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hiring company URN, e.g. \"urn:li:fs_normalized_company:\"." }, "companyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric hiring-company id parsed from the company URN." }, "companyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hiring company's LinkedIn page URL." }, "companyUniversalName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hiring company vanity slug, e.g. \"los-alamos-national-laboratory\"." }, "companyStaffCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Hiring company employee count on LinkedIn." }, "companyDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hiring company's short description shown on the posting." }, "companyLogoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hiring company logo URL." } }, "required": [ "jobId", "jobUrn", "dashJobUrn", "jobUrl", "applyUrl", "title", "standardizedTitleUrn", "standardizedTitleId", "standardizedTitleName", "description", "location", "geoUrn", "geoId", "countryUrn", "countryCode", "workRemoteAllowed", "experienceLevel", "employmentType", "employmentTypeUrn", "employmentTypeCode", "industries", "jobFunctions", "inferredBenefits", "jobState", "sourceDomain", "listedAt", "listedAtEpochMs", "originalListedAt", "originalListedAtEpochMs", "expiresAt", "expiresAtEpochMs", "closedAt", "closedAtEpochMs", "applies", "views", "companyName", "companyUrn", "companyId", "companyUrl", "companyUniversalName", "companyStaffCount", "companyDescription", "companyLogoUrl" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.getJob({\n jobUrl: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/get-posts/from-company": { "post": { "summary": "List posts published by a LinkedIn company", "tags": [ "LinkedIn" ], "description": "List the posts a LinkedIn company page has published, newest first. Each post includes the text, images, shared links, publish date and reaction, comment and share counts. Page through older posts with `start`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "description": "Number of results to skip. Defaults to 0.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "universalName": { "type": "string", "pattern": "^[^\\s/?#&=]+$", "description": "The company universal name, e.g. \"openai\"." }, "count": { "default": 10, "description": "Number of results to return per page (1–100). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "universalName" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "posts": { "type": "array", "items": { "type": "object", "properties": { "urn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shareUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shareAudience": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "actorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorPublicIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorHeadline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ], "additionalProperties": false } }, "article": { "anyOf": [ { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "imageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "subtitle", "url", "imageUrl" ], "additionalProperties": false }, { "type": "null" } ] }, "event": { "anyOf": [ { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "url", "date", "location" ], "additionalProperties": false }, { "type": "null" } ] }, "job": { "anyOf": [ { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "company", "location", "url" ], "additionalProperties": false }, { "type": "null" } ] }, "socialCounts": { "anyOf": [ { "type": "object", "properties": { "numLikes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "numComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "numShares": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reactionTypeCounts": { "type": "array", "items": { "type": "object", "properties": { "reactionType": { "type": "string" }, "count": { "type": "number" } }, "required": [ "reactionType", "count" ], "additionalProperties": false } } }, "required": [ "numLikes", "numComments", "numShares", "reactionTypeCounts" ], "additionalProperties": false }, { "type": "null" } ] }, "resharedPost": { "anyOf": [ { "type": "object", "properties": { "actorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorPublicIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shareUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "actorName", "text", "actorUrn", "actorPublicIdentifier", "actorUrl", "publishedAt", "urn", "url", "shareUrn" ], "additionalProperties": false }, { "type": "null" } ] }, "comments": { "type": "array", "items": { "type": "object", "properties": { "urn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commenterName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commenterUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "parentCommentUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "urn", "text", "commenterName", "commenterUrn", "createdTime", "parentCommentUrn" ], "additionalProperties": false } } }, "required": [ "urn", "url", "shareUrn", "shareAudience", "text", "publishedAt", "postedAt", "actorName", "actorUrn", "actorPublicIdentifier", "actorUrl", "actorHeadline", "images", "article", "event", "job", "socialCounts", "resharedPost", "comments" ], "additionalProperties": false } }, "paging": { "type": "object", "properties": { "start": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "start", "count", "total" ], "additionalProperties": false } }, "required": [ "posts", "paging" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.getPostsFromCompany({\n universalName: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/get-posts/from-profile": { "post": { "summary": "List posts published by a LinkedIn profile", "tags": [ "LinkedIn" ], "description": "List the posts and reposts a LinkedIn member has published, newest first, going back through their full history. Each post includes the text, images, shared links, publish date and reaction, comment and share counts. Page through older posts with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "Pagination cursor from a previous response's `nextCursor` to fetch the next page.", "type": "string", "minLength": 1 }, "publicId": { "type": "string", "pattern": "^[^\\s/?#&=]+$", "description": "The member public identity, e.g. \"williamhgates\"." }, "count": { "default": 10, "description": "Most results to return per page (1–100). Defaults to 10. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "publicId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "posts": { "type": "array", "items": { "type": "object", "properties": { "urn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shareUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shareAudience": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "actorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorPublicIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorHeadline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ], "additionalProperties": false } }, "article": { "anyOf": [ { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "imageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "subtitle", "url", "imageUrl" ], "additionalProperties": false }, { "type": "null" } ] }, "event": { "anyOf": [ { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "url", "date", "location" ], "additionalProperties": false }, { "type": "null" } ] }, "job": { "anyOf": [ { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "company", "location", "url" ], "additionalProperties": false }, { "type": "null" } ] }, "socialCounts": { "anyOf": [ { "type": "object", "properties": { "numLikes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "numComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "numShares": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reactionTypeCounts": { "type": "array", "items": { "type": "object", "properties": { "reactionType": { "type": "string" }, "count": { "type": "number" } }, "required": [ "reactionType", "count" ], "additionalProperties": false } } }, "required": [ "numLikes", "numComments", "numShares", "reactionTypeCounts" ], "additionalProperties": false }, { "type": "null" } ] }, "resharedPost": { "anyOf": [ { "type": "object", "properties": { "actorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorPublicIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shareUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "actorName", "text", "actorUrn", "actorPublicIdentifier", "actorUrl", "publishedAt", "urn", "url", "shareUrn" ], "additionalProperties": false }, { "type": "null" } ] }, "comments": { "type": "array", "items": { "type": "object", "properties": { "urn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commenterName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commenterUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "parentCommentUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "urn", "text", "commenterName", "commenterUrn", "createdTime", "parentCommentUrn" ], "additionalProperties": false } } }, "required": [ "urn", "url", "shareUrn", "shareAudience", "text", "publishedAt", "postedAt", "actorName", "actorUrn", "actorPublicIdentifier", "actorUrl", "actorHeadline", "images", "article", "event", "job", "socialCounts", "resharedPost", "comments" ], "additionalProperties": false } }, "paging": { "type": "object", "properties": { "start": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "start", "count", "total" ], "additionalProperties": false }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "posts", "paging", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.getPostsFromProfile({\n publicId: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/get-post-detail": { "post": { "summary": "Fetch a single LinkedIn post by URN", "tags": [ "LinkedIn" ], "description": "Get a single LinkedIn post by its activity URN. Returns the post text, author, publish date, images, any shared article, event or job, reaction, comment and share counts, and its comments. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "activityUrn": { "type": "string", "pattern": "^urn:li:(activity|ugcPost|share):\\d+$", "description": "The post/update to fetch — a `urn:li:activity:`, e.g. \"urn:li:activity:7300000000000000000\"." } }, "required": [ "activityUrn" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "urn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shareUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shareAudience": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "actorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorPublicIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorHeadline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ], "additionalProperties": false } }, "article": { "anyOf": [ { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "imageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "subtitle", "url", "imageUrl" ], "additionalProperties": false }, { "type": "null" } ] }, "event": { "anyOf": [ { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "url", "date", "location" ], "additionalProperties": false }, { "type": "null" } ] }, "job": { "anyOf": [ { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "company", "location", "url" ], "additionalProperties": false }, { "type": "null" } ] }, "socialCounts": { "anyOf": [ { "type": "object", "properties": { "numLikes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "numComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "numShares": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reactionTypeCounts": { "type": "array", "items": { "type": "object", "properties": { "reactionType": { "type": "string" }, "count": { "type": "number" } }, "required": [ "reactionType", "count" ], "additionalProperties": false } } }, "required": [ "numLikes", "numComments", "numShares", "reactionTypeCounts" ], "additionalProperties": false }, { "type": "null" } ] }, "resharedPost": { "anyOf": [ { "type": "object", "properties": { "actorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorPublicIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shareUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "actorName", "text", "actorUrn", "actorPublicIdentifier", "actorUrl", "publishedAt", "urn", "url", "shareUrn" ], "additionalProperties": false }, { "type": "null" } ] }, "comments": { "type": "array", "items": { "type": "object", "properties": { "urn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commenterName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commenterUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "parentCommentUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "urn", "text", "commenterName", "commenterUrn", "createdTime", "parentCommentUrn" ], "additionalProperties": false } } }, "required": [ "urn", "url", "shareUrn", "shareAudience", "text", "publishedAt", "postedAt", "actorName", "actorUrn", "actorPublicIdentifier", "actorUrl", "actorHeadline", "images", "article", "event", "job", "socialCounts", "resharedPost", "comments" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.getPostDetail({\n activityUrn: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/get-activity-comments": { "post": { "summary": "Fetch the comment thread on a LinkedIn post", "tags": [ "LinkedIn" ], "description": "Get the comments on a LinkedIn post by its activity URN. Each comment includes the text, author, time posted and like and reply counts. Page through the rest with `start`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "description": "Number of results to skip. Defaults to 0.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "activityUrn": { "type": "string", "pattern": "^urn:li:(activity|ugcPost|share):\\d+$", "description": "The activity to fetch comments for — a `urn:li:activity:`, e.g. \"urn:li:activity:7300000000000000000\"." }, "count": { "default": 10, "description": "Number of results to return per page (1–100). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "activityUrn" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "array", "items": { "type": "object", "properties": { "urn": { "type": "string" }, "activityId": { "type": "string" }, "commentId": { "type": "string" }, "parentCommentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "authorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "numLikes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "numComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "urn", "activityId", "commentId", "parentCommentId", "text", "authorName", "createdTime", "numLikes", "numComments" ], "additionalProperties": false } } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.getActivityComments({\n activityUrn: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/get-profile-comments": { "post": { "summary": "List comments made by a LinkedIn profile", "tags": [ "LinkedIn" ], "description": "List the comments a LinkedIn member has written on posts across LinkedIn. Each comment includes the text, time posted, a link to it and the post it was left on. Page through older comments with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "Pagination cursor from a previous response's `nextCursor` to fetch the next page.", "type": "string", "minLength": 1 }, "publicId": { "type": "string", "pattern": "^[^\\s/?#&=]+$", "description": "The member public identity, e.g. \"williamhgates\"." }, "count": { "default": 10, "description": "Most results to return per page (1–100). Defaults to 10. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "publicId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "comments": { "type": "array", "items": { "type": "object", "properties": { "urn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The comment's `urn:li:fsd_comment:(...)` (from `urn` or `entityUrn`)." }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The comment body text." }, "authorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the commenter (the member)." }, "createdTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Creation time as a Unix epoch in milliseconds (LinkedIn's native unit)." }, "permalink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute or site-relative permalink to the comment." }, "rootActivityUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URN of the post/activity the comment was left on, when resolvable." }, "parentCommentUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URN of the parent comment when this is a reply, else null." } }, "required": [ "urn", "text", "authorName", "createdTime", "permalink", "rootActivityUrn", "parentCommentUrn" ], "additionalProperties": false }, "description": "Comments on this page." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "comments", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.getProfileComments({\n publicId: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/get-profile-reactions": { "post": { "summary": "List posts a LinkedIn member reacted to", "tags": [ "LinkedIn" ], "description": "List the posts a LinkedIn member has liked or reacted to, newest first. Each item includes the reaction type, the post's text and author, and its like, comment and share counts. Page through older reactions with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "Pagination cursor from a previous response's `nextCursor` to fetch the next page.", "type": "string", "minLength": 1 }, "publicId": { "type": "string", "pattern": "^[^\\s/?#&=]+$", "description": "The member public identity, e.g. \"williamhgates\"." }, "count": { "default": 10, "description": "Most results to return per page (1–100). Defaults to 10. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "publicId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "reactions": { "type": "array", "items": { "type": "object", "properties": { "urn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reacted-to update's `urn:li:fsd_update:(...)` — the feed's stable id for this row." }, "reactionType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reaction the member left (e.g. \"LIKE\", \"PRAISE\"). Always null: the profile Reactions feed does not surface the per-post reaction type." }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Body text of the post the member reacted to." }, "createdTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Time the reaction was left, as a Unix epoch in milliseconds. Always null: the profile Reactions feed does not surface a per-reaction timestamp." }, "permalink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute or site-relative permalink to the reacted-to post." }, "rootActivityUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URN of the post/activity the member reacted to, e.g. urn:li:activity:. Chain into /linkedin/get-post-detail." }, "activityId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric id parsed off `rootActivityUrn`, e.g. \"7461151461910114304\"." }, "shareUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The underlying share URN (urn:li:share:) when the reacted-to post is a share." }, "numLikes": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total reactions on the reacted-to post." }, "numComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total comments on the reacted-to post." }, "numShares": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total reposts of the reacted-to post." }, "authorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the author of the reacted-to post." }, "authorType": { "anyOf": [ { "type": "string", "enum": [ "member", "company" ] }, { "type": "null" } ], "description": "Whether the reacted-to post was authored by a member or a company." }, "authorUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The author's entity URN — urn:li:member: for a person or urn:li:company: for a company." }, "authorProfileUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The author's fully-decorated URN — urn:li:fsd_profile: (member) or urn:li:fsd_company: (company). This is the id the profile/company endpoints key on." }, "authorPublicId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The author's public handle / vanity slug (the `/in/` or `/company/` segment). Chain into /linkedin/get-profile or /linkedin/get-company." }, "authorUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the author's profile or company page." }, "authorHeadline": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The author's headline / occupation line (or follower count for a company)." }, "authorImage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the author's profile picture or company logo." } }, "required": [ "urn", "reactionType", "text", "createdTime", "permalink", "rootActivityUrn", "activityId", "shareUrn", "numLikes", "numComments", "numShares", "authorName", "authorType", "authorUrn", "authorProfileUrn", "authorPublicId", "authorUrl", "authorHeadline", "authorImage" ], "additionalProperties": false }, "description": "Posts the member reacted to on this page, newest first." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "reactions", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.getProfileReactions({\n publicId: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/get-post-reactions": { "post": { "summary": "List the members who reacted to a LinkedIn post", "tags": [ "LinkedIn" ], "description": "List the members who reacted to a LinkedIn post, with each person's name, headline, profile link, profile picture and the reaction they chose. Page through the rest with `start`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "description": "Number of results to skip. Defaults to 0.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "activityUrn": { "type": "string", "pattern": "^urn:li:(activity|ugcPost|share):\\d+$", "description": "The post/update to fetch reactions for — a `urn:li:activity:`, e.g. \"urn:li:activity:7300000000000000000\"." }, "count": { "default": 10, "description": "Number of results to return per page (1–100). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "activityUrn" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "array", "items": { "type": "object", "properties": { "reactorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the member who reacted." }, "reactorHeadline": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reactor's headline / occupation, when present." }, "reactorProfileUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reactor's canonical dash profile URN (`urn:li:fsd_profile:`) — the stable id other profile endpoints accept." }, "reactorMemberId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reactor's numeric member id (from `urn:li:member:`), a stable id that survives handle changes." }, "reactorPublicId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reactor's public identity — the `/in/` handle, e.g. \"williamhgates\"." }, "reactorProfileUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the reactor's profile, when the public id is resolvable." }, "reactorProfileImage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the reactor's profile picture, when present." }, "reactionType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reaction the member left, e.g. \"LIKE\", \"PRAISE\", \"EMPATHY\", \"INTEREST\", \"APPRECIATION\", \"ENTERTAINMENT\"." } }, "required": [ "reactorName", "reactorHeadline", "reactorProfileUrn", "reactorMemberId", "reactorPublicId", "reactorProfileUrl", "reactorProfileImage", "reactionType" ], "additionalProperties": false } } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.getPostReactions({\n activityUrn: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/search/all": { "post": { "summary": "Global LinkedIn search", "tags": [ "LinkedIn" ], "description": "Search all of LinkedIn by keyword in one call and get matching people, companies, jobs, posts, groups and more, along with the total number of matches. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "pattern": "\\S", "description": "Keyword(s) to search LinkedIn for, e.g. \"openai\", \"software engineer\", \"fintech\"." }, "start": { "description": "Pagination offset into the result list. Defaults to 0.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "count": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "keyword" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "profileUrn": { "type": "string", "description": "Stable profile identifier (always present), e.g. urn:li:fsd_profile:." }, "publicIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public vanity handle from the /in/ URL; null for private members." }, "profileUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical profile URL (https://www.linkedin.com/in/); null when the member is private / out-of-network and renders as an anonymous \"LinkedIn Member\"." }, "memberUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "urn:li:member:; null for private \"LinkedIn Member\" results." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name; \"LinkedIn Member\" when the profile is private/out-of-network." }, "headline": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Occupation / headline line." }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Location line, e.g. \"Bengaluru\", \"Odisha, India\"." }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Keyword-match snippet, when LinkedIn surfaces one." }, "profilePictureUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Largest available profile photo URL." }, "networkDistance": { "anyOf": [ { "type": "string", "enum": [ "self", "1st", "2nd", "3rd", "out_of_network" ], "description": "Connection degree relative to the searching account: self, 1st/2nd/3rd-degree connection, or out_of_network (beyond 3rd, rendered \"3rd+\")." }, { "type": "null" } ], "description": "Connection degree relative to the searching account." }, "degreeBadge": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Human-facing degree label next to the name, e.g. \"2nd\", \"3rd+\"." }, "verified": { "type": "boolean", "description": "Whether LinkedIn shows the blue verification badge." }, "insight": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Social-proof line, e.g. \"1 mutual connection\", \"28K followers\"." }, "type": { "type": "string", "enum": [ "person" ] } }, "required": [ "profileUrn", "publicIdentifier", "profileUrl", "memberUrn", "name", "headline", "location", "summary", "profilePictureUrl", "networkDistance", "degreeBadge", "verified", "insight", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "companyUrn": { "type": "string", "description": "Stable company identifier (always present), e.g. urn:li:fsd_company:." }, "companyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric company id parsed from the company URN, e.g. \"24468\"." }, "universalName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vanity slug from the /company// URL, e.g. \"ai4\"." }, "companyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical company page URL (https://www.linkedin.com/company//)." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Company display name." }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Industry, e.g. \"IT Services and IT Consulting\"." }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Headquarters location line, e.g. \"Brooklyn, New York\"." }, "followersLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Follower count label as rendered by LinkedIn, e.g. \"31K followers\"." }, "followersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Approximate follower count parsed from the label (K/M suffixes expanded), e.g. 31000." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tagline / short description snippet." }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Largest available company logo URL." }, "type": { "type": "string", "enum": [ "company" ] } }, "required": [ "companyUrn", "companyId", "universalName", "companyUrl", "name", "industry", "location", "followersLabel", "followersCount", "description", "logoUrl", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "jobUrn": { "type": "string", "description": "Stable job identifier (always present), e.g. urn:li:fsd_jobPosting:." }, "jobId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric job id parsed from the job URN, e.g. \"4417164255\"." }, "jobUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical job posting URL (https://www.linkedin.com/jobs/view//), tracking params stripped." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Job title." }, "companyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hiring company name." }, "companyUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hiring company URN resolved from the posting logo, e.g. urn:li:fsd_company:." }, "companyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric hiring-company id parsed from the company URN." }, "companySlug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hiring company vanity slug parsed from the logo link, e.g. \"neuralink\" (stable handle for chaining company lookups)." }, "companyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical hiring company page URL (https://www.linkedin.com/company//), tracking params stripped." }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Job location line, e.g. \"India (Remote)\"." }, "salary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Compensation range label when the card advertises pay, e.g. \"$68K/yr - $75K/yr\". Null when the posting exposes no salary." }, "listedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Listing date in ISO-8601 (UTC), parsed from the posting's LISTED_DATE timestamp." }, "listedAtEpochMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Listing date as a Unix epoch in milliseconds, e.g. 1781870351000." }, "imageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hiring company logo URL." }, "reposted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this posting is a repost of an earlier listing (useful for de-duplicating and gauging freshness)." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the posting carries LinkedIn's verified-hiring badge. Null when the card exposes no verification." }, "type": { "type": "string", "enum": [ "job" ] } }, "required": [ "jobUrn", "jobId", "jobUrl", "title", "companyName", "companyUrn", "companyId", "companySlug", "companyUrl", "location", "salary", "listedAt", "listedAtEpochMs", "imageUrl", "reposted", "verified", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "groupUrn": { "type": "string", "description": "Stable group identifier (always present), e.g. urn:li:fsd_group:." }, "groupId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric group id parsed from the group URN, e.g. \"62352\"." }, "groupUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical group URL (https://www.linkedin.com/groups/)." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Group name." }, "membersLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Member count label as rendered by LinkedIn, e.g. \"3M members\", \"629K members\"." }, "membersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Approximate member count parsed from the label (K/M suffixes expanded)." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Group description / about text." }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Largest available group logo URL." }, "type": { "type": "string", "enum": [ "group" ] } }, "required": [ "groupUrn", "groupId", "groupUrl", "name", "membersLabel", "membersCount", "description", "logoUrl", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "productUrn": { "type": "string", "description": "Stable product identifier (always present), e.g. urn:li:organizationalPage:." }, "productId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric product id parsed from the product URN, e.g. \"87256149\"." }, "universalName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vanity slug from the /products// URL." }, "productUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical product page URL (https://www.linkedin.com/products//)." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Product name." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Product category, e.g. \"Customer Relationship Management (CRM) Software\"." }, "maker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The company that makes the product (the \"by \" segment)." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Product description / tagline." }, "topFeatures": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated top features as surfaced by LinkedIn (raw human-readable text)." }, "integrations": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated notable integrations (raw human-readable text)." }, "usedBy": { "type": "array", "items": { "type": "object", "properties": { "companyUrn": { "type": "string", "description": "urn:li:fsd_company: of a company that uses the product." }, "companyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric company id parsed from the company URN." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Company display name." }, "companyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical company page URL (https://www.linkedin.com/company//)." } }, "required": [ "companyUrn", "companyId", "name", "companyUrl" ], "additionalProperties": false }, "description": "Named companies that use the product, resolved from the \"Used by …\" social-proof line." }, "usedByOthersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Count of additional unnamed users beyond those listed in `usedBy` (the \"and N others\" remainder)." }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Largest available product logo URL." }, "type": { "type": "string", "enum": [ "product" ] } }, "required": [ "productUrn", "productId", "universalName", "productUrl", "name", "category", "maker", "description", "topFeatures", "integrations", "usedBy", "usedByOthersCount", "logoUrl", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "courseUrn": { "type": "string", "description": "Stable course identifier (always present), e.g. urn:li:lyndaCourse:." }, "courseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric course id parsed from the course URN, e.g. \"4571000\"." }, "universalName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vanity slug from the /learning/ URL." }, "courseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical course URL (tracking/courseClaim query params stripped)." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Course title." }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Content format, e.g. \"Course\"." }, "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Duration label as rendered by LinkedIn, e.g. \"3h 43m\"." }, "durationMinutes": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total course length in minutes, parsed from the duration label (e.g. \"3h 43m\" -> 223)." }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Instructor / author name." }, "releasedDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Release date label, e.g. \"Jan 9, 2025\"." }, "releasedYear": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Release year parsed from the release date label, e.g. 2025." }, "releasedMonth": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Release month (1-12) parsed from the release date label, e.g. 1 for January." }, "releasedDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Release day of month parsed from the release date label, e.g. 9." }, "thumbnailUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Largest available course thumbnail URL." }, "type": { "type": "string", "enum": [ "course" ] } }, "required": [ "courseUrn", "courseId", "universalName", "courseUrl", "name", "format", "duration", "durationMinutes", "author", "releasedDate", "releasedYear", "releasedMonth", "releasedDay", "thumbnailUrl", "type" ], "additionalProperties": false } ] }, "description": "Ranked, interleaved results across every entity type." }, "keyword": { "type": "string", "description": "The keyword(s) that were searched on LinkedIn." }, "totalResultCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of matching results reported by LinkedIn (not the number returned in this page)." } }, "required": [ "results", "keyword", "totalResultCount" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.searchAll({\n keyword: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/search/companies": { "post": { "summary": "Search LinkedIn companies", "tags": [ "LinkedIn" ], "description": "Find LinkedIn companies by keyword. Each result includes the company name, industry, location, follower count, description, logo and page link. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "pattern": "\\S", "description": "Keyword(s) to search LinkedIn for, e.g. \"openai\", \"software engineer\", \"fintech\"." }, "start": { "description": "Pagination offset into the result list. Defaults to 0.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "count": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "keyword" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "companyUrn": { "type": "string", "description": "Stable company identifier (always present), e.g. urn:li:fsd_company:." }, "companyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric company id parsed from the company URN, e.g. \"24468\"." }, "universalName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vanity slug from the /company// URL, e.g. \"ai4\"." }, "companyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical company page URL (https://www.linkedin.com/company//)." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Company display name." }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Industry, e.g. \"IT Services and IT Consulting\"." }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Headquarters location line, e.g. \"Brooklyn, New York\"." }, "followersLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Follower count label as rendered by LinkedIn, e.g. \"31K followers\"." }, "followersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Approximate follower count parsed from the label (K/M suffixes expanded), e.g. 31000." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tagline / short description snippet." }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Largest available company logo URL." } }, "required": [ "companyUrn", "companyId", "universalName", "companyUrl", "name", "industry", "location", "followersLabel", "followersCount", "description", "logoUrl" ], "additionalProperties": false }, "description": "Ranked matching companies." }, "keyword": { "type": "string", "description": "The keyword(s) that were searched on LinkedIn." }, "totalResultCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of matching results reported by LinkedIn (not the number returned in this page)." } }, "required": [ "companies", "keyword", "totalResultCount" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.searchCompanies({\n keyword: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/search/courses": { "post": { "summary": "Search LinkedIn courses", "tags": [ "LinkedIn" ], "description": "Find LinkedIn Learning courses by keyword. Each result includes the course title, author, format, duration, release date and thumbnail. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "pattern": "\\S", "description": "Keyword(s) to search LinkedIn for, e.g. \"openai\", \"software engineer\", \"fintech\"." }, "start": { "description": "Pagination offset into the result list. Defaults to 0.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "count": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "keyword" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "courses": { "type": "array", "items": { "type": "object", "properties": { "courseUrn": { "type": "string", "description": "Stable course identifier (always present), e.g. urn:li:lyndaCourse:." }, "courseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric course id parsed from the course URN, e.g. \"4571000\"." }, "universalName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vanity slug from the /learning/ URL." }, "courseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical course URL (tracking/courseClaim query params stripped)." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Course title." }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Content format, e.g. \"Course\"." }, "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Duration label as rendered by LinkedIn, e.g. \"3h 43m\"." }, "durationMinutes": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total course length in minutes, parsed from the duration label (e.g. \"3h 43m\" -> 223)." }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Instructor / author name." }, "releasedDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Release date label, e.g. \"Jan 9, 2025\"." }, "releasedYear": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Release year parsed from the release date label, e.g. 2025." }, "releasedMonth": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Release month (1-12) parsed from the release date label, e.g. 1 for January." }, "releasedDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Release day of month parsed from the release date label, e.g. 9." }, "thumbnailUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Largest available course thumbnail URL." } }, "required": [ "courseUrn", "courseId", "universalName", "courseUrl", "name", "format", "duration", "durationMinutes", "author", "releasedDate", "releasedYear", "releasedMonth", "releasedDay", "thumbnailUrl" ], "additionalProperties": false }, "description": "Ranked matching courses." }, "keyword": { "type": "string", "description": "The keyword(s) that were searched on LinkedIn." }, "totalResultCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of matching results reported by LinkedIn (not the number returned in this page)." } }, "required": [ "courses", "keyword", "totalResultCount" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.searchCourses({\n keyword: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/search/events": { "post": { "summary": "Search LinkedIn events", "tags": [ "LinkedIn" ], "description": "Find LinkedIn events by keyword. Each result includes the event name, date, location, organizer, attendee count, whether it is online and its link. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "pattern": "\\S", "description": "Keyword(s) to search LinkedIn for, e.g. \"openai\", \"software engineer\", \"fintech\"." }, "start": { "description": "Pagination offset into the result list. Defaults to 0.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "count": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "keyword" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "eventUrn": { "type": "string", "description": "Stable event identifier (always present), e.g. urn:li:event:." }, "eventId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric event id parsed from the event URN, e.g. \"7449421775681175552\"." }, "eventUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical event URL (https://www.linkedin.com/events//)." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Event name." }, "dateLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Human-readable start date/time label including timezone, e.g. \"Tomorrow, 1:30 PM CEST\", \"Fri, Jun 26, 9:00 AM CDT\"." }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Venue / location line, e.g. \"Online\", \"Ljubljana, Ljubljana, SI\"." }, "isOnline": { "type": "boolean", "description": "Whether the event is held online (location reads \"Online\")." }, "organizer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hosting organizer name (the \"By \" segment)." }, "attendeesLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Raw attendee social-proof label as rendered by LinkedIn, e.g. \"31 attendees\"." }, "attendeesCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Attendee count parsed from the attendees label, when present." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full event description / agenda text." }, "imageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Largest available event banner / logo image URL." } }, "required": [ "eventUrn", "eventId", "eventUrl", "name", "dateLabel", "location", "isOnline", "organizer", "attendeesLabel", "attendeesCount", "description", "imageUrl" ], "additionalProperties": false }, "description": "Ranked matching events." }, "keyword": { "type": "string", "description": "The keyword(s) that were searched on LinkedIn." }, "totalResultCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of matching results reported by LinkedIn (not the number returned in this page)." } }, "required": [ "events", "keyword", "totalResultCount" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.searchEvents({\n keyword: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/search/groups": { "post": { "summary": "Search LinkedIn groups", "tags": [ "LinkedIn" ], "description": "Find LinkedIn groups by keyword. Each result includes the group name, member count, description, logo and link. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "pattern": "\\S", "description": "Keyword(s) to search LinkedIn for, e.g. \"openai\", \"software engineer\", \"fintech\"." }, "start": { "description": "Pagination offset into the result list. Defaults to 0.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "count": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "keyword" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "object", "properties": { "groupUrn": { "type": "string", "description": "Stable group identifier (always present), e.g. urn:li:fsd_group:." }, "groupId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric group id parsed from the group URN, e.g. \"62352\"." }, "groupUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical group URL (https://www.linkedin.com/groups/)." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Group name." }, "membersLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Member count label as rendered by LinkedIn, e.g. \"3M members\", \"629K members\"." }, "membersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Approximate member count parsed from the label (K/M suffixes expanded)." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Group description / about text." }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Largest available group logo URL." } }, "required": [ "groupUrn", "groupId", "groupUrl", "name", "membersLabel", "membersCount", "description", "logoUrl" ], "additionalProperties": false }, "description": "Ranked matching groups." }, "keyword": { "type": "string", "description": "The keyword(s) that were searched on LinkedIn." }, "totalResultCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of matching results reported by LinkedIn (not the number returned in this page)." } }, "required": [ "groups", "keyword", "totalResultCount" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.searchGroups({\n keyword: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/search/jobs": { "post": { "summary": "Search LinkedIn jobs", "tags": [ "LinkedIn" ], "description": "Search LinkedIn job listings by keyword, with optional filters for location, workplace type, experience level, job type and date posted. Each result includes the job title, company, location, salary when listed and posting date. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "pattern": "\\S", "description": "Keyword(s) to search LinkedIn for, e.g. \"openai\", \"software engineer\", \"fintech\"." }, "start": { "description": "Pagination offset into the result list. Defaults to 0.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "count": { "default": 10, "description": "Number of results to return per page (1–100). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 100 }, "location": { "description": "Geographic location to filter jobs by, e.g. \"San Francisco Bay Area\", \"India\", \"Remote\".", "type": "string" }, "workplaceType": { "type": "string", "enum": [ "on-site", "remote", "hybrid" ], "description": "Restrict to jobs with this workplace arrangement." }, "experienceLevel": { "type": "string", "enum": [ "internship", "entry-level", "associate", "mid-senior", "director", "executive" ], "description": "Restrict to jobs at this seniority level." }, "jobType": { "type": "string", "enum": [ "full-time", "part-time", "contract", "temporary", "internship", "volunteer", "other" ], "description": "Restrict to jobs with this employment type." }, "datePosted": { "type": "string", "enum": [ "past-24h", "past-week", "past-month" ], "description": "Restrict to posts published within a recent window." } }, "required": [ "keyword" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "object", "properties": { "jobUrn": { "type": "string", "description": "Stable job identifier (always present), e.g. urn:li:fsd_jobPosting:." }, "jobId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric job id parsed from the job URN, e.g. \"4417164255\"." }, "jobUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical job posting URL (https://www.linkedin.com/jobs/view//), tracking params stripped." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Job title." }, "companyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hiring company name." }, "companyUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hiring company URN resolved from the posting logo, e.g. urn:li:fsd_company:." }, "companyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric hiring-company id parsed from the company URN." }, "companySlug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hiring company vanity slug parsed from the logo link, e.g. \"neuralink\" (stable handle for chaining company lookups)." }, "companyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical hiring company page URL (https://www.linkedin.com/company//), tracking params stripped." }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Job location line, e.g. \"India (Remote)\"." }, "salary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Compensation range label when the card advertises pay, e.g. \"$68K/yr - $75K/yr\". Null when the posting exposes no salary." }, "listedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Listing date in ISO-8601 (UTC), parsed from the posting's LISTED_DATE timestamp." }, "listedAtEpochMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Listing date as a Unix epoch in milliseconds, e.g. 1781870351000." }, "imageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hiring company logo URL." }, "reposted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this posting is a repost of an earlier listing (useful for de-duplicating and gauging freshness)." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the posting carries LinkedIn's verified-hiring badge. Null when the card exposes no verification." } }, "required": [ "jobUrn", "jobId", "jobUrl", "title", "companyName", "companyUrn", "companyId", "companySlug", "companyUrl", "location", "salary", "listedAt", "listedAtEpochMs", "imageUrl", "reposted", "verified" ], "additionalProperties": false }, "description": "Ranked matching job postings." }, "keyword": { "type": "string", "description": "The keyword(s) that were searched on LinkedIn." }, "totalResultCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of matching results reported by LinkedIn (not the number returned in this page)." } }, "required": [ "jobs", "keyword", "totalResultCount" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.searchJobs({\n keyword: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/search/people": { "post": { "summary": "Search LinkedIn people", "tags": [ "LinkedIn" ], "description": "Find LinkedIn members by keyword, such as a name, job title or skill. Each result includes the name, headline, location, profile link and profile picture. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "pattern": "\\S", "description": "Keyword(s) to search LinkedIn for, e.g. \"openai\", \"software engineer\", \"fintech\"." }, "start": { "description": "Pagination offset into the result list. Defaults to 0.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "count": { "default": 10, "description": "Number of results to return per page (1–50). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 50 } }, "required": [ "keyword" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "people": { "type": "array", "items": { "type": "object", "properties": { "profileUrn": { "type": "string", "description": "Stable profile identifier (always present), e.g. urn:li:fsd_profile:." }, "publicIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public vanity handle from the /in/ URL; null for private members." }, "profileUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical profile URL (https://www.linkedin.com/in/); null when the member is private / out-of-network and renders as an anonymous \"LinkedIn Member\"." }, "memberUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "urn:li:member:; null for private \"LinkedIn Member\" results." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name; \"LinkedIn Member\" when the profile is private/out-of-network." }, "headline": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Occupation / headline line." }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Location line, e.g. \"Bengaluru\", \"Odisha, India\"." }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Keyword-match snippet, when LinkedIn surfaces one." }, "profilePictureUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Largest available profile photo URL." }, "networkDistance": { "anyOf": [ { "type": "string", "enum": [ "self", "1st", "2nd", "3rd", "out_of_network" ], "description": "Connection degree relative to the searching account: self, 1st/2nd/3rd-degree connection, or out_of_network (beyond 3rd, rendered \"3rd+\")." }, { "type": "null" } ], "description": "Connection degree relative to the searching account." }, "degreeBadge": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Human-facing degree label next to the name, e.g. \"2nd\", \"3rd+\"." }, "verified": { "type": "boolean", "description": "Whether LinkedIn shows the blue verification badge." }, "insight": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Social-proof line, e.g. \"1 mutual connection\", \"28K followers\"." } }, "required": [ "profileUrn", "publicIdentifier", "profileUrl", "memberUrn", "name", "headline", "location", "summary", "profilePictureUrl", "networkDistance", "degreeBadge", "verified", "insight" ], "additionalProperties": false }, "description": "Ranked matching members." }, "keyword": { "type": "string", "description": "The keyword(s) that were searched on LinkedIn." }, "totalResultCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of matching results reported by LinkedIn (not the number returned in this page)." } }, "required": [ "people", "keyword", "totalResultCount" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.searchPeople({\n keyword: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/search/posts": { "post": { "summary": "Search LinkedIn posts", "tags": [ "LinkedIn" ], "description": "Search LinkedIn posts by keyword, sorted by relevance or newest first and optionally limited to a recent time window. Each result includes the post text, author, link and reaction, comment and share counts. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "pattern": "\\S", "description": "Keyword(s) to search LinkedIn for, e.g. \"openai\", \"software engineer\", \"fintech\"." }, "start": { "description": "Pagination offset into the result list. Defaults to 0.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "count": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 }, "sortOrder": { "type": "string", "enum": [ "date_posted", "relevance" ], "description": "Result ordering: \"date_posted\" for newest-first, \"relevance\" for LinkedIn ranking." }, "datePosted": { "type": "string", "enum": [ "past-24h", "past-week", "past-month" ], "description": "Restrict to posts published within a recent window." } }, "required": [ "keyword" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "posts": { "type": "array", "items": { "type": "object", "properties": { "urn": { "type": "string", "description": "Canonical activity URN, e.g. urn:li:activity:7473669660778000385." }, "shareUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The underlying share URN (urn:li:share:), when present." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public post URL, stripped of tracking params." }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Post commentary / body text." }, "postedAgo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relative age label as shown by LinkedIn, e.g. \"5h\", \"1d\", \"2w\"." }, "author": { "anyOf": [ { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author display name." }, "headline": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author headline / occupation line." }, "profileUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical author profile URL." }, "profileUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author profile URN, e.g. urn:li:fsd_profile:." }, "memberUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author member URN, e.g. urn:li:member:." }, "imageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author profile picture URL." } }, "required": [ "name", "headline", "profileUrl", "profileUrn", "memberUrn", "imageUrl" ], "additionalProperties": false }, { "type": "null" } ], "description": "The post author." }, "socialCounts": { "anyOf": [ { "type": "object", "properties": { "numLikes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "numComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "numShares": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reactionTypeCounts": { "type": "array", "items": { "type": "object", "properties": { "reactionType": { "type": "string" }, "count": { "type": "number" } }, "required": [ "reactionType", "count" ], "additionalProperties": false } } }, "required": [ "numLikes", "numComments", "numShares", "reactionTypeCounts" ], "additionalProperties": false }, { "type": "null" } ], "description": "Like / comment / share counts." }, "content": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "article" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Shared article title." }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Article subtitle / source line." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Article URL, stripped of tracking params." }, "imageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Article cover image URL." } }, "required": [ "type", "title", "subtitle", "url", "imageUrl" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "entity" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Entity card title." }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Entity card subtitle." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Entity card description." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Entity URL, stripped of tracking params." }, "imageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Entity image / logo URL." } }, "required": [ "type", "title", "subtitle", "description", "url", "imageUrl" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "images" ] }, "urls": { "type": "array", "items": { "type": "string" }, "description": "Image URLs attached to the post." } }, "required": [ "type", "urls" ], "additionalProperties": false } ] }, { "type": "null" } ], "description": "Attached content (article, entity card, or images), if any." } }, "required": [ "urn", "shareUrn", "url", "text", "postedAgo", "author", "socialCounts", "content" ], "additionalProperties": false }, "description": "Ranked matching posts." }, "keyword": { "type": "string", "description": "The keyword(s) that were searched on LinkedIn." }, "totalResultCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of matching results reported by LinkedIn (not the number returned in this page)." } }, "required": [ "posts", "keyword", "totalResultCount" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.searchPosts({\n keyword: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/search/products": { "post": { "summary": "Search LinkedIn products", "tags": [ "LinkedIn" ], "description": "Find software products listed on LinkedIn by keyword. Each result includes the product name, category, maker, description, top features, integrations and the companies that use it. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "pattern": "\\S", "description": "Keyword(s) to search LinkedIn for, e.g. \"openai\", \"software engineer\", \"fintech\"." }, "start": { "description": "Pagination offset into the result list. Defaults to 0.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "count": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "keyword" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "products": { "type": "array", "items": { "type": "object", "properties": { "productUrn": { "type": "string", "description": "Stable product identifier (always present), e.g. urn:li:organizationalPage:." }, "productId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric product id parsed from the product URN, e.g. \"87256149\"." }, "universalName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vanity slug from the /products// URL." }, "productUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical product page URL (https://www.linkedin.com/products//)." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Product name." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Product category, e.g. \"Customer Relationship Management (CRM) Software\"." }, "maker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The company that makes the product (the \"by \" segment)." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Product description / tagline." }, "topFeatures": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated top features as surfaced by LinkedIn (raw human-readable text)." }, "integrations": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated notable integrations (raw human-readable text)." }, "usedBy": { "type": "array", "items": { "type": "object", "properties": { "companyUrn": { "type": "string", "description": "urn:li:fsd_company: of a company that uses the product." }, "companyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric company id parsed from the company URN." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Company display name." }, "companyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical company page URL (https://www.linkedin.com/company//)." } }, "required": [ "companyUrn", "companyId", "name", "companyUrl" ], "additionalProperties": false }, "description": "Named companies that use the product, resolved from the \"Used by …\" social-proof line." }, "usedByOthersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Count of additional unnamed users beyond those listed in `usedBy` (the \"and N others\" remainder)." }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Largest available product logo URL." } }, "required": [ "productUrn", "productId", "universalName", "productUrl", "name", "category", "maker", "description", "topFeatures", "integrations", "usedBy", "usedByOthersCount", "logoUrl" ], "additionalProperties": false }, "description": "Ranked matching products." }, "keyword": { "type": "string", "description": "The keyword(s) that were searched on LinkedIn." }, "totalResultCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of matching results reported by LinkedIn (not the number returned in this page)." } }, "required": [ "products", "keyword", "totalResultCount" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.searchProducts({\n keyword: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/search/schools": { "post": { "summary": "Search LinkedIn schools", "tags": [ "LinkedIn" ], "description": "Find schools and universities on LinkedIn by keyword. Each result includes the name, location, student and alumni count, description, logo and page link. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "pattern": "\\S", "description": "Keyword(s) to search LinkedIn for, e.g. \"openai\", \"software engineer\", \"fintech\"." }, "start": { "description": "Pagination offset into the result list. Defaults to 0.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "count": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "keyword" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "schools": { "type": "array", "items": { "type": "object", "properties": { "schoolUrn": { "type": "string", "description": "Stable school identifier (always present). Schools are modelled as organizations, so this is a company URN, e.g. urn:li:fsd_company:." }, "schoolId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric school id parsed from the school URN, e.g. \"2151499\"." }, "universalName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vanity slug from the /company// URL." }, "schoolUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical school page URL (https://www.linkedin.com/company//)." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "School display name." }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Location line, e.g. \"Melbourne, Victoria\"." }, "studentsAndAlumniLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Raw label, e.g. \"4,525 students and alumni on LinkedIn\"." }, "studentsAndAlumniCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Parsed count of students & alumni on LinkedIn, when present." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Tagline / short description snippet." }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Largest available school logo URL." } }, "required": [ "schoolUrn", "schoolId", "universalName", "schoolUrl", "name", "location", "studentsAndAlumniLabel", "studentsAndAlumniCount", "description", "logoUrl" ], "additionalProperties": false }, "description": "Ranked matching schools." }, "keyword": { "type": "string", "description": "The keyword(s) that were searched on LinkedIn." }, "totalResultCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of matching results reported by LinkedIn (not the number returned in this page)." } }, "required": [ "schools", "keyword", "totalResultCount" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.searchSchools({\n keyword: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/linkedin/search/services": { "post": { "summary": "Search LinkedIn services", "tags": [ "LinkedIn" ], "description": "Find professionals offering services on LinkedIn by keyword. Each result includes the provider's name, headline, location, the services they offer and their service page link. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "keyword": { "type": "string", "pattern": "\\S", "description": "Keyword(s) to search LinkedIn for, e.g. \"openai\", \"software engineer\", \"fintech\"." }, "start": { "description": "Pagination offset into the result list. Defaults to 0.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "count": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "keyword" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "services": { "type": "array", "items": { "type": "object", "properties": { "profileUrn": { "type": "string", "description": "The provider's profile URN (always present), e.g. urn:li:fsd_profile:." }, "memberUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "urn:li:member:; null for private members." }, "servicePageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Service-marketplace page URL (https://www.linkedin.com/services/page/)." }, "servicePageId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Service page id (the token from the /services/page/ URL)." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider display name." }, "headline": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider headline / tagline." }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider location, e.g. \"Chandigarh, India\"." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "About / service description text." }, "services": { "type": "array", "items": { "type": "string" }, "description": "Service categories the provider offers, e.g. [\"Logo Design\", \"Brand Design\"]." }, "profilePictureUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Largest available provider profile photo URL." } }, "required": [ "profileUrn", "memberUrn", "servicePageUrl", "servicePageId", "name", "headline", "location", "description", "services", "profilePictureUrl" ], "additionalProperties": false }, "description": "Ranked matching service providers." }, "keyword": { "type": "string", "description": "The keyword(s) that were searched on LinkedIn." }, "totalResultCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of matching results reported by LinkedIn (not the number returned in this page)." } }, "required": [ "services", "keyword", "totalResultCount" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.linkedin.searchServices({\n keyword: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/reddit/get-post": { "post": { "summary": "Fetch a Reddit post with its comments", "tags": [ "Reddit" ], "description": "Get a Reddit post from its URL together with its comments. Returns the title, body, author, subreddit, score, upvote ratio, comment count and links, plus the comment thread. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Full URL of the Reddit post to fetch (with or without query)." } }, "required": [ "url" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "post": { "type": "object", "properties": { "id": { "type": "string", "description": "Base-36 post id without the `t3_` prefix, e.g. \"1u3a0cd\"." }, "fullname": { "type": "string", "description": "Reddit fullname including the type prefix, e.g. \"t3_1u3a0cd\"." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Post title." }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author username, or \"[deleted]\" when removed." }, "authorFullname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author account fullname, e.g. \"t2_98wao505\"." }, "selftext": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-post body text (empty string for link posts)." }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Net score (upvotes minus downvotes)." }, "ups": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Upvote count (Reddit fuzzes this for large posts)." }, "downs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Downvote count (Reddit reports 0 on modern listings)." }, "upvoteRatio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Fraction of votes that are upvotes, 0–1." }, "numComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total comment count." }, "numCrossposts": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times this post has been crossposted." }, "totalAwardsReceived": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of awards the post has received." }, "gilded": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post has been gilded (gold awards)." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Creation time as a Unix epoch in seconds." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Creation time as an ISO-8601 UTC string, e.g. \"2026-07-12T…Z\"." }, "editedUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Last edit time as a Unix epoch in seconds, or null if never edited." }, "editedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last edit time as an ISO-8601 UTC string, or null if never edited." }, "permalink": { "type": "string", "description": "Site-relative permalink path, e.g. \"/r/technology/comments/…\"." }, "postUrl": { "type": "string", "description": "Absolute URL to the post on reddit.com." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL the post points to — the external link for link posts, or the post permalink for self posts." }, "subreddit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name without prefix, e.g. \"technology\"." }, "subredditId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit fullname (stable `t5_` id), e.g. \"t5_2fwo\" — use to look the community up." }, "subredditUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the subreddit on reddit.com." }, "subredditPrefixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name with prefix, e.g. \"r/technology\"." }, "subredditSubscribers": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subscriber count of the subreddit, when present." }, "subredditType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit access type, e.g. \"public\", \"restricted\", \"private\"." }, "linkFlairText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link flair label, if any." }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Source domain, e.g. \"self.technology\" or \"nytimes.com\"." }, "thumbnail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Thumbnail URL, or a sentinel like \"self\"/\"default\"/\"nsfw\" when there is no image." }, "distinguished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Distinguish state set by staff, e.g. \"moderator\" or \"admin\"; null for regular posts." }, "isSelf": { "type": "boolean", "description": "Whether this is a self (text) post." }, "isVideo": { "type": "boolean", "description": "Whether the post hosts a Reddit video." }, "isOriginalContent": { "type": "boolean", "description": "Whether the post is flagged as original content (OC)." }, "over18": { "type": "boolean", "description": "Whether the post is marked NSFW." }, "spoiler": { "type": "boolean", "description": "Whether the post is marked as a spoiler." }, "stickied": { "type": "boolean", "description": "Whether the post is pinned to the top of its subreddit feed." }, "pinned": { "type": "boolean", "description": "Whether the post is pinned to the author's profile." }, "archived": { "type": "boolean", "description": "Whether the post is archived (no longer accepts votes)." }, "contestMode": { "type": "boolean", "description": "Whether comments are shown in randomized contest-mode order." }, "locked": { "type": "boolean", "description": "Whether commenting is locked." } }, "required": [ "id", "fullname", "title", "author", "authorFullname", "selftext", "score", "ups", "downs", "upvoteRatio", "numComments", "numCrossposts", "totalAwardsReceived", "gilded", "createdUtc", "createdAt", "editedUtc", "editedAt", "permalink", "postUrl", "url", "subreddit", "subredditId", "subredditUrl", "subredditPrefixed", "subredditSubscribers", "subredditType", "linkFlairText", "domain", "thumbnail", "distinguished", "isSelf", "isVideo", "isOriginalContent", "over18", "spoiler", "stickied", "pinned", "archived", "contestMode", "locked" ], "additionalProperties": false, "description": "The post itself." }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/schema0" }, "description": "Top-level comments, each with its nested replies." } }, "required": [ "post", "comments" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.reddit.getPost({\n url: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/reddit/get-comment": { "post": { "summary": "Fetch a single Reddit comment with its thread", "tags": [ "Reddit" ], "description": "Get a single Reddit comment from its permalink, together with the post it was left on and the replies beneath it. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "permalink": { "type": "string", "description": "Permalink of the Reddit comment to fetch — an absolute URL or a site-relative path, e.g. \"/r/programming/comments/1u3a0cd/title/labc123/\"." } }, "required": [ "permalink" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "post": { "type": "object", "properties": { "id": { "type": "string", "description": "Base-36 post id without the `t3_` prefix, e.g. \"1u3a0cd\"." }, "fullname": { "type": "string", "description": "Reddit fullname including the type prefix, e.g. \"t3_1u3a0cd\"." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Post title." }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author username, or \"[deleted]\" when removed." }, "authorFullname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author account fullname, e.g. \"t2_98wao505\"." }, "selftext": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-post body text (empty string for link posts)." }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Net score (upvotes minus downvotes)." }, "ups": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Upvote count (Reddit fuzzes this for large posts)." }, "downs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Downvote count (Reddit reports 0 on modern listings)." }, "upvoteRatio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Fraction of votes that are upvotes, 0–1." }, "numComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total comment count." }, "numCrossposts": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times this post has been crossposted." }, "totalAwardsReceived": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of awards the post has received." }, "gilded": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post has been gilded (gold awards)." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Creation time as a Unix epoch in seconds." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Creation time as an ISO-8601 UTC string, e.g. \"2026-07-12T…Z\"." }, "editedUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Last edit time as a Unix epoch in seconds, or null if never edited." }, "editedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last edit time as an ISO-8601 UTC string, or null if never edited." }, "permalink": { "type": "string", "description": "Site-relative permalink path, e.g. \"/r/technology/comments/…\"." }, "postUrl": { "type": "string", "description": "Absolute URL to the post on reddit.com." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL the post points to — the external link for link posts, or the post permalink for self posts." }, "subreddit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name without prefix, e.g. \"technology\"." }, "subredditId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit fullname (stable `t5_` id), e.g. \"t5_2fwo\" — use to look the community up." }, "subredditUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the subreddit on reddit.com." }, "subredditPrefixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name with prefix, e.g. \"r/technology\"." }, "subredditSubscribers": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subscriber count of the subreddit, when present." }, "subredditType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit access type, e.g. \"public\", \"restricted\", \"private\"." }, "linkFlairText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link flair label, if any." }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Source domain, e.g. \"self.technology\" or \"nytimes.com\"." }, "thumbnail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Thumbnail URL, or a sentinel like \"self\"/\"default\"/\"nsfw\" when there is no image." }, "distinguished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Distinguish state set by staff, e.g. \"moderator\" or \"admin\"; null for regular posts." }, "isSelf": { "type": "boolean", "description": "Whether this is a self (text) post." }, "isVideo": { "type": "boolean", "description": "Whether the post hosts a Reddit video." }, "isOriginalContent": { "type": "boolean", "description": "Whether the post is flagged as original content (OC)." }, "over18": { "type": "boolean", "description": "Whether the post is marked NSFW." }, "spoiler": { "type": "boolean", "description": "Whether the post is marked as a spoiler." }, "stickied": { "type": "boolean", "description": "Whether the post is pinned to the top of its subreddit feed." }, "pinned": { "type": "boolean", "description": "Whether the post is pinned to the author's profile." }, "archived": { "type": "boolean", "description": "Whether the post is archived (no longer accepts votes)." }, "contestMode": { "type": "boolean", "description": "Whether comments are shown in randomized contest-mode order." }, "locked": { "type": "boolean", "description": "Whether commenting is locked." } }, "required": [ "id", "fullname", "title", "author", "authorFullname", "selftext", "score", "ups", "downs", "upvoteRatio", "numComments", "numCrossposts", "totalAwardsReceived", "gilded", "createdUtc", "createdAt", "editedUtc", "editedAt", "permalink", "postUrl", "url", "subreddit", "subredditId", "subredditUrl", "subredditPrefixed", "subredditSubscribers", "subredditType", "linkFlairText", "domain", "thumbnail", "distinguished", "isSelf", "isVideo", "isOriginalContent", "over18", "spoiler", "stickied", "pinned", "archived", "contestMode", "locked" ], "additionalProperties": false, "description": "The post the comment was left on." }, "comment": { "$ref": "#/components/schemas/schema0" } }, "required": [ "post", "comment" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.reddit.getComment({\n permalink: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/reddit/get-subreddit": { "post": { "summary": "Fetch subreddit metadata", "tags": [ "Reddit" ], "description": "Get the details of a subreddit by name: title, description, subscriber count, creation date, icon and banner, posting settings and the community rules. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "subreddit": { "type": "string", "description": "Subreddit name, with or without the \"r/\" prefix, e.g. \"programming\"." } }, "required": [ "subreddit" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Base-36 subreddit id without the `t5_` prefix, e.g. \"3b9u5\"." }, "fullname": { "type": "string", "description": "Reddit fullname including the prefix, e.g. \"t5_3b9u5\"." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name without prefix, e.g. \"OpenAI\"." }, "namePrefixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name with prefix, e.g. \"r/OpenAI\"." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit display title." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full sidebar description / community info (markdown)." }, "publicDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Short public description shown in listings and search." }, "subscribers": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subscriber count." }, "activeUserCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Approximate number of users online now, when reported." }, "over18": { "type": "boolean", "description": "Whether the subreddit is marked NSFW." }, "quarantine": { "type": "boolean", "description": "Whether the subreddit is quarantined." }, "subredditType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Access type, e.g. \"public\", \"restricted\", \"private\"." }, "submissionType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Allowed submission kinds: \"any\", \"link\", or \"self\"." }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Primary language code, e.g. \"en\"." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Site-relative path, e.g. \"/r/OpenAI/\"." }, "subredditUrl": { "type": "string", "description": "Absolute URL to the subreddit on reddit.com." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Creation time as a Unix epoch in seconds." }, "iconUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Community icon (falls back to the legacy icon), if any." }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Banner image URL, if any." }, "headerImageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Legacy header image URL, if any." }, "primaryColor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Primary theme color (hex), if set." }, "keyColor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Key theme color (hex), if set." }, "bannerBackgroundColor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Banner background color (hex), if set." }, "wikiEnabled": { "type": "boolean", "description": "Whether the subreddit wiki is enabled." }, "restrictPosting": { "type": "boolean", "description": "Whether posting is restricted to approved users." }, "restrictCommenting": { "type": "boolean", "description": "Whether commenting is restricted to approved users." }, "allowImages": { "type": "boolean", "description": "Whether image posts are allowed." }, "allowVideos": { "type": "boolean", "description": "Whether video posts are allowed." }, "allowGalleries": { "type": "boolean", "description": "Whether gallery posts are allowed." }, "allowPolls": { "type": "boolean", "description": "Whether poll posts are allowed." }, "spoilersEnabled": { "type": "boolean", "description": "Whether posts can be flagged as spoilers." }, "rules": { "type": "array", "items": { "type": "object", "properties": { "shortName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Short rule label, e.g. \"Rule 1: Relevance\"." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full rule text (markdown)." }, "violationReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Reason shown to users reporting a violation of this rule." }, "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What the rule applies to: \"all\", \"link\" (posts), or \"comment\"." }, "priority": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Display order of the rule (0-based)." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "When the rule was created, as a Unix epoch in seconds." } }, "required": [ "shortName", "description", "violationReason", "kind", "priority", "createdUtc" ], "additionalProperties": false }, "description": "The subreddit-specific rules, in display order." }, "siteRules": { "type": "array", "items": { "type": "string" }, "description": "Reddit-wide site rules that also apply, e.g. \"Spam\"." } }, "required": [ "id", "fullname", "name", "namePrefixed", "title", "description", "publicDescription", "subscribers", "activeUserCount", "over18", "quarantine", "subredditType", "submissionType", "lang", "url", "subredditUrl", "createdUtc", "iconUrl", "bannerUrl", "headerImageUrl", "primaryColor", "keyColor", "bannerBackgroundColor", "wikiEnabled", "restrictPosting", "restrictCommenting", "allowImages", "allowVideos", "allowGalleries", "allowPolls", "spoilersEnabled", "rules", "siteRules" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.reddit.getSubreddit({\n subreddit: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/reddit/get-user": { "post": { "summary": "Fetch a Reddit user profile", "tags": [ "Reddit" ], "description": "Get a Reddit user's public profile by username: post and comment karma, account creation date, avatar and whether the account is verified, a moderator or has Reddit Premium. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Reddit username, with or without the \"u/\" prefix, e.g. \"spez\"." } }, "required": [ "username" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Base-36 account id without the `t2_` prefix, e.g. \"10knboj9s0\"." }, "username": { "type": "string", "description": "Reddit username, e.g. \"OpenAI\"." }, "profileUrl": { "type": "string", "description": "Absolute profile URL (https://www.reddit.com/user//)." }, "commentKarma": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Comment karma." }, "linkKarma": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Post (link) karma." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Account creation time as a Unix epoch in seconds." }, "iconUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile/snoovatar avatar URL, if any." }, "isGold": { "type": "boolean", "description": "Whether the account has Reddit Premium." }, "isMod": { "type": "boolean", "description": "Whether the account moderates any subreddit." }, "isEmployee": { "type": "boolean", "description": "Whether the account is a Reddit employee." }, "verified": { "type": "boolean", "description": "Whether the account is verified." }, "hasVerifiedEmail": { "type": "boolean", "description": "Whether the account has a verified email." }, "acceptFollowers": { "type": "boolean", "description": "Whether the account accepts followers." } }, "required": [ "id", "username", "profileUrl", "commentKarma", "linkKarma", "createdUtc", "iconUrl", "isGold", "isMod", "isEmployee", "verified", "hasVerifiedEmail", "acceptFollowers" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.reddit.getUser({\n username: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/reddit/list-user-posts": { "post": { "summary": "List a Reddit user's posts", "tags": [ "Reddit" ], "description": "List the most recent posts a Reddit user has submitted, with the title, body, subreddit, score, comment count and link of each. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Reddit username, with or without the \"u/\" prefix, e.g. \"spez\"." }, "count": { "default": 10, "description": "Number of posts to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "username" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Base-36 post id without the `t3_` prefix, e.g. \"1u3a0cd\"." }, "fullname": { "type": "string", "description": "Reddit fullname including the type prefix, e.g. \"t3_1u3a0cd\"." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Post title." }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author username, or \"[deleted]\" when removed." }, "authorFullname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author account fullname, e.g. \"t2_98wao505\"." }, "selftext": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-post body text (empty string for link posts)." }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Net score (upvotes minus downvotes)." }, "ups": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Upvote count (Reddit fuzzes this for large posts)." }, "downs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Downvote count (Reddit reports 0 on modern listings)." }, "upvoteRatio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Fraction of votes that are upvotes, 0–1." }, "numComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total comment count." }, "numCrossposts": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times this post has been crossposted." }, "totalAwardsReceived": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of awards the post has received." }, "gilded": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post has been gilded (gold awards)." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Creation time as a Unix epoch in seconds." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Creation time as an ISO-8601 UTC string, e.g. \"2026-07-12T…Z\"." }, "editedUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Last edit time as a Unix epoch in seconds, or null if never edited." }, "editedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last edit time as an ISO-8601 UTC string, or null if never edited." }, "permalink": { "type": "string", "description": "Site-relative permalink path, e.g. \"/r/technology/comments/…\"." }, "postUrl": { "type": "string", "description": "Absolute URL to the post on reddit.com." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL the post points to — the external link for link posts, or the post permalink for self posts." }, "subreddit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name without prefix, e.g. \"technology\"." }, "subredditId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit fullname (stable `t5_` id), e.g. \"t5_2fwo\" — use to look the community up." }, "subredditUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the subreddit on reddit.com." }, "subredditPrefixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name with prefix, e.g. \"r/technology\"." }, "subredditSubscribers": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subscriber count of the subreddit, when present." }, "subredditType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit access type, e.g. \"public\", \"restricted\", \"private\"." }, "linkFlairText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link flair label, if any." }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Source domain, e.g. \"self.technology\" or \"nytimes.com\"." }, "thumbnail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Thumbnail URL, or a sentinel like \"self\"/\"default\"/\"nsfw\" when there is no image." }, "distinguished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Distinguish state set by staff, e.g. \"moderator\" or \"admin\"; null for regular posts." }, "isSelf": { "type": "boolean", "description": "Whether this is a self (text) post." }, "isVideo": { "type": "boolean", "description": "Whether the post hosts a Reddit video." }, "isOriginalContent": { "type": "boolean", "description": "Whether the post is flagged as original content (OC)." }, "over18": { "type": "boolean", "description": "Whether the post is marked NSFW." }, "spoiler": { "type": "boolean", "description": "Whether the post is marked as a spoiler." }, "stickied": { "type": "boolean", "description": "Whether the post is pinned to the top of its subreddit feed." }, "pinned": { "type": "boolean", "description": "Whether the post is pinned to the author's profile." }, "archived": { "type": "boolean", "description": "Whether the post is archived (no longer accepts votes)." }, "contestMode": { "type": "boolean", "description": "Whether comments are shown in randomized contest-mode order." }, "locked": { "type": "boolean", "description": "Whether commenting is locked." } }, "required": [ "id", "fullname", "title", "author", "authorFullname", "selftext", "score", "ups", "downs", "upvoteRatio", "numComments", "numCrossposts", "totalAwardsReceived", "gilded", "createdUtc", "createdAt", "editedUtc", "editedAt", "permalink", "postUrl", "url", "subreddit", "subredditId", "subredditUrl", "subredditPrefixed", "subredditSubscribers", "subredditType", "linkFlairText", "domain", "thumbnail", "distinguished", "isSelf", "isVideo", "isOriginalContent", "over18", "spoiler", "stickied", "pinned", "archived", "contestMode", "locked" ], "additionalProperties": false } } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.reddit.listUserPosts({\n username: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/reddit/list-user-comments": { "post": { "summary": "List a Reddit user's comments", "tags": [ "Reddit" ], "description": "List the most recent comments a Reddit user has written. Each comment includes its text, score and subreddit, along with the title, link and author of the post it was left on. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Reddit username, with or without the \"u/\" prefix, e.g. \"spez\"." }, "count": { "default": 10, "description": "Number of comments to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "username" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/schema0" }, { "type": "object", "properties": { "linkTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Title of the post the comment was left on." }, "linkPermalink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL of the post the comment was left on." }, "linkAuthor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username of the post's author, or \"[deleted]\" when removed — use to look the poster up." }, "linkAuthorUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the post author's profile, or null when the author is deleted." }, "linkUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL the post points to — the external link for link posts, or the post permalink for self posts." }, "linkNumComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total comment count on the post the comment was left on." }, "linkOver18": { "type": "boolean", "description": "Whether the post the comment was left on is marked NSFW." } }, "required": [ "linkTitle", "linkPermalink", "linkAuthor", "linkAuthorUrl", "linkUrl", "linkNumComments", "linkOver18" ], "additionalProperties": false } ] } } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.reddit.listUserComments({\n username: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/reddit/list-user-overview": { "post": { "summary": "List a Reddit user's mixed post/comment activity", "tags": [ "Reddit" ], "description": "List a Reddit user's recent activity, posts and comments together in the order they were made, as it appears on their profile. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Reddit username, with or without the \"u/\" prefix, e.g. \"spez\"." }, "count": { "default": 10, "description": "Number of overview items to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "username" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "post" ] }, "post": { "type": "object", "properties": { "id": { "type": "string", "description": "Base-36 post id without the `t3_` prefix, e.g. \"1u3a0cd\"." }, "fullname": { "type": "string", "description": "Reddit fullname including the type prefix, e.g. \"t3_1u3a0cd\"." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Post title." }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author username, or \"[deleted]\" when removed." }, "authorFullname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author account fullname, e.g. \"t2_98wao505\"." }, "selftext": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-post body text (empty string for link posts)." }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Net score (upvotes minus downvotes)." }, "ups": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Upvote count (Reddit fuzzes this for large posts)." }, "downs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Downvote count (Reddit reports 0 on modern listings)." }, "upvoteRatio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Fraction of votes that are upvotes, 0–1." }, "numComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total comment count." }, "numCrossposts": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times this post has been crossposted." }, "totalAwardsReceived": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of awards the post has received." }, "gilded": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post has been gilded (gold awards)." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Creation time as a Unix epoch in seconds." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Creation time as an ISO-8601 UTC string, e.g. \"2026-07-12T…Z\"." }, "editedUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Last edit time as a Unix epoch in seconds, or null if never edited." }, "editedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last edit time as an ISO-8601 UTC string, or null if never edited." }, "permalink": { "type": "string", "description": "Site-relative permalink path, e.g. \"/r/technology/comments/…\"." }, "postUrl": { "type": "string", "description": "Absolute URL to the post on reddit.com." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL the post points to — the external link for link posts, or the post permalink for self posts." }, "subreddit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name without prefix, e.g. \"technology\"." }, "subredditId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit fullname (stable `t5_` id), e.g. \"t5_2fwo\" — use to look the community up." }, "subredditUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the subreddit on reddit.com." }, "subredditPrefixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name with prefix, e.g. \"r/technology\"." }, "subredditSubscribers": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subscriber count of the subreddit, when present." }, "subredditType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit access type, e.g. \"public\", \"restricted\", \"private\"." }, "linkFlairText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link flair label, if any." }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Source domain, e.g. \"self.technology\" or \"nytimes.com\"." }, "thumbnail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Thumbnail URL, or a sentinel like \"self\"/\"default\"/\"nsfw\" when there is no image." }, "distinguished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Distinguish state set by staff, e.g. \"moderator\" or \"admin\"; null for regular posts." }, "isSelf": { "type": "boolean", "description": "Whether this is a self (text) post." }, "isVideo": { "type": "boolean", "description": "Whether the post hosts a Reddit video." }, "isOriginalContent": { "type": "boolean", "description": "Whether the post is flagged as original content (OC)." }, "over18": { "type": "boolean", "description": "Whether the post is marked NSFW." }, "spoiler": { "type": "boolean", "description": "Whether the post is marked as a spoiler." }, "stickied": { "type": "boolean", "description": "Whether the post is pinned to the top of its subreddit feed." }, "pinned": { "type": "boolean", "description": "Whether the post is pinned to the author's profile." }, "archived": { "type": "boolean", "description": "Whether the post is archived (no longer accepts votes)." }, "contestMode": { "type": "boolean", "description": "Whether comments are shown in randomized contest-mode order." }, "locked": { "type": "boolean", "description": "Whether commenting is locked." } }, "required": [ "id", "fullname", "title", "author", "authorFullname", "selftext", "score", "ups", "downs", "upvoteRatio", "numComments", "numCrossposts", "totalAwardsReceived", "gilded", "createdUtc", "createdAt", "editedUtc", "editedAt", "permalink", "postUrl", "url", "subreddit", "subredditId", "subredditUrl", "subredditPrefixed", "subredditSubscribers", "subredditType", "linkFlairText", "domain", "thumbnail", "distinguished", "isSelf", "isVideo", "isOriginalContent", "over18", "spoiler", "stickied", "pinned", "archived", "contestMode", "locked" ], "additionalProperties": false, "description": "The submitted post." } }, "required": [ "type", "post" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "comment" ] }, "comment": { "allOf": [ { "$ref": "#/components/schemas/schema0" }, { "type": "object", "properties": { "linkTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Title of the post the comment was left on." }, "linkPermalink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL of the post the comment was left on." }, "linkAuthor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username of the post's author, or \"[deleted]\" when removed — use to look the poster up." }, "linkAuthorUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the post author's profile, or null when the author is deleted." }, "linkUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL the post points to — the external link for link posts, or the post permalink for self posts." }, "linkNumComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total comment count on the post the comment was left on." }, "linkOver18": { "type": "boolean", "description": "Whether the post the comment was left on is marked NSFW." } }, "required": [ "linkTitle", "linkPermalink", "linkAuthor", "linkAuthorUrl", "linkUrl", "linkNumComments", "linkOver18" ], "additionalProperties": false } ], "description": "The authored comment." } }, "required": [ "type", "comment" ], "additionalProperties": false } ] } } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.reddit.listUserOverview({\n username: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/reddit/list-subreddit-posts": { "post": { "summary": "List posts in a subreddit feed", "tags": [ "Reddit" ], "description": "List the posts in a subreddit sorted by hot, new, top or rising, optionally limited to a time window. Each post includes the title, body, author, score, comment count and link. Page through results with the `after` cursor. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "subreddit": { "type": "string", "description": "Subreddit name, with or without the \"r/\" prefix, e.g. \"programming\"." }, "sort": { "type": "string", "enum": [ "hot", "new", "top", "rising" ], "description": "Feed ordering. Defaults to \"hot\"." }, "time": { "type": "string", "enum": [ "hour", "day", "week", "month", "year", "all" ], "description": "Restrict results to a recent window. Defaults to \"all\"." }, "count": { "default": 10, "description": "Number of posts to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 }, "after": { "description": "Pagination cursor (a Reddit fullname returned as `after` from a previous page).", "type": "string" } }, "required": [ "subreddit" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Base-36 post id without the `t3_` prefix, e.g. \"1u3a0cd\"." }, "fullname": { "type": "string", "description": "Reddit fullname including the type prefix, e.g. \"t3_1u3a0cd\"." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Post title." }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author username, or \"[deleted]\" when removed." }, "authorFullname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author account fullname, e.g. \"t2_98wao505\"." }, "selftext": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-post body text (empty string for link posts)." }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Net score (upvotes minus downvotes)." }, "ups": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Upvote count (Reddit fuzzes this for large posts)." }, "downs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Downvote count (Reddit reports 0 on modern listings)." }, "upvoteRatio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Fraction of votes that are upvotes, 0–1." }, "numComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total comment count." }, "numCrossposts": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times this post has been crossposted." }, "totalAwardsReceived": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of awards the post has received." }, "gilded": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post has been gilded (gold awards)." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Creation time as a Unix epoch in seconds." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Creation time as an ISO-8601 UTC string, e.g. \"2026-07-12T…Z\"." }, "editedUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Last edit time as a Unix epoch in seconds, or null if never edited." }, "editedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last edit time as an ISO-8601 UTC string, or null if never edited." }, "permalink": { "type": "string", "description": "Site-relative permalink path, e.g. \"/r/technology/comments/…\"." }, "postUrl": { "type": "string", "description": "Absolute URL to the post on reddit.com." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL the post points to — the external link for link posts, or the post permalink for self posts." }, "subreddit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name without prefix, e.g. \"technology\"." }, "subredditId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit fullname (stable `t5_` id), e.g. \"t5_2fwo\" — use to look the community up." }, "subredditUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the subreddit on reddit.com." }, "subredditPrefixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name with prefix, e.g. \"r/technology\"." }, "subredditSubscribers": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subscriber count of the subreddit, when present." }, "subredditType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit access type, e.g. \"public\", \"restricted\", \"private\"." }, "linkFlairText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link flair label, if any." }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Source domain, e.g. \"self.technology\" or \"nytimes.com\"." }, "thumbnail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Thumbnail URL, or a sentinel like \"self\"/\"default\"/\"nsfw\" when there is no image." }, "distinguished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Distinguish state set by staff, e.g. \"moderator\" or \"admin\"; null for regular posts." }, "isSelf": { "type": "boolean", "description": "Whether this is a self (text) post." }, "isVideo": { "type": "boolean", "description": "Whether the post hosts a Reddit video." }, "isOriginalContent": { "type": "boolean", "description": "Whether the post is flagged as original content (OC)." }, "over18": { "type": "boolean", "description": "Whether the post is marked NSFW." }, "spoiler": { "type": "boolean", "description": "Whether the post is marked as a spoiler." }, "stickied": { "type": "boolean", "description": "Whether the post is pinned to the top of its subreddit feed." }, "pinned": { "type": "boolean", "description": "Whether the post is pinned to the author's profile." }, "archived": { "type": "boolean", "description": "Whether the post is archived (no longer accepts votes)." }, "contestMode": { "type": "boolean", "description": "Whether comments are shown in randomized contest-mode order." }, "locked": { "type": "boolean", "description": "Whether commenting is locked." } }, "required": [ "id", "fullname", "title", "author", "authorFullname", "selftext", "score", "ups", "downs", "upvoteRatio", "numComments", "numCrossposts", "totalAwardsReceived", "gilded", "createdUtc", "createdAt", "editedUtc", "editedAt", "permalink", "postUrl", "url", "subreddit", "subredditId", "subredditUrl", "subredditPrefixed", "subredditSubscribers", "subredditType", "linkFlairText", "domain", "thumbnail", "distinguished", "isSelf", "isVideo", "isOriginalContent", "over18", "spoiler", "stickied", "pinned", "archived", "contestMode", "locked" ], "additionalProperties": false }, "description": "Posts in the subreddit feed." }, "subreddit": { "type": "string", "description": "The subreddit these posts belong to (without the \"r/\" prefix)." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (Reddit `after` fullname), or null when there are no more results." } }, "required": [ "posts", "subreddit", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.reddit.listSubredditPosts({\n subreddit: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/reddit/list-subreddit-comments": { "post": { "summary": "List recent comments in a subreddit", "tags": [ "Reddit" ], "description": "List the newest comments posted across a subreddit, with the text, author and score of each and the post it was left on. Page through results with the `after` cursor. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "subreddit": { "type": "string", "description": "Subreddit name, with or without the \"r/\" prefix, e.g. \"programming\"." }, "after": { "description": "Pagination cursor (a Reddit fullname returned as `after` from a previous page).", "type": "string" }, "count": { "default": 10, "description": "Number of comments to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "subreddit" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "comments": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/schema0" }, { "type": "object", "properties": { "linkTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Title of the post the comment was left on." }, "linkPermalink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL of the post the comment was left on." }, "linkAuthor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username of the post's author, or \"[deleted]\" when removed — use to look the poster up." }, "linkAuthorUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the post author's profile, or null when the author is deleted." }, "linkUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL the post points to — the external link for link posts, or the post permalink for self posts." }, "linkNumComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total comment count on the post the comment was left on." }, "linkOver18": { "type": "boolean", "description": "Whether the post the comment was left on is marked NSFW." } }, "required": [ "linkTitle", "linkPermalink", "linkAuthor", "linkAuthorUrl", "linkUrl", "linkNumComments", "linkOver18" ], "additionalProperties": false } ] }, "description": "Recent comments in the subreddit stream." }, "subreddit": { "type": "string", "description": "The subreddit these comments belong to (without the \"r/\" prefix)." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (Reddit `after` fullname), or null when there are no more results." } }, "required": [ "comments", "subreddit", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.reddit.listSubredditComments({\n subreddit: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/reddit/search/all": { "post": { "summary": "Search Reddit across posts, communities and users", "tags": [ "Reddit" ], "description": "Search Reddit for a phrase and get matching posts, communities and users in one call, sorted by relevance, hot, top, new or comment count and optionally limited to a time window. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "pattern": "\\S", "description": "The text to search Reddit for, e.g. \"openai\", \"best keyboard\"." }, "subreddit": { "description": "Restrict the search to a single subreddit (name with or without the \"r/\" prefix). Only applies to post search.", "type": "string" }, "sort": { "type": "string", "enum": [ "relevance", "hot", "top", "new", "comments" ], "description": "Result ordering. Defaults to \"relevance\"." }, "time": { "type": "string", "enum": [ "hour", "day", "week", "month", "year", "all" ], "description": "Restrict results to a recent window. Defaults to \"all\"." }, "after": { "description": "Pagination cursor (a Reddit fullname returned as `after` from a previous page).", "type": "string" }, "limit": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "query" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Base-36 post id without the `t3_` prefix, e.g. \"1u3a0cd\"." }, "fullname": { "type": "string", "description": "Reddit fullname including the type prefix, e.g. \"t3_1u3a0cd\"." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Post title." }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author username, or \"[deleted]\" when removed." }, "authorFullname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author account fullname, e.g. \"t2_98wao505\"." }, "selftext": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-post body text (empty string for link posts)." }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Net score (upvotes minus downvotes)." }, "ups": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Upvote count (Reddit fuzzes this for large posts)." }, "downs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Downvote count (Reddit reports 0 on modern listings)." }, "upvoteRatio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Fraction of votes that are upvotes, 0–1." }, "numComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total comment count." }, "numCrossposts": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times this post has been crossposted." }, "totalAwardsReceived": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of awards the post has received." }, "gilded": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post has been gilded (gold awards)." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Creation time as a Unix epoch in seconds." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Creation time as an ISO-8601 UTC string, e.g. \"2026-07-12T…Z\"." }, "editedUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Last edit time as a Unix epoch in seconds, or null if never edited." }, "editedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last edit time as an ISO-8601 UTC string, or null if never edited." }, "permalink": { "type": "string", "description": "Site-relative permalink path, e.g. \"/r/technology/comments/…\"." }, "postUrl": { "type": "string", "description": "Absolute URL to the post on reddit.com." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL the post points to — the external link for link posts, or the post permalink for self posts." }, "subreddit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name without prefix, e.g. \"technology\"." }, "subredditId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit fullname (stable `t5_` id), e.g. \"t5_2fwo\" — use to look the community up." }, "subredditUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the subreddit on reddit.com." }, "subredditPrefixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name with prefix, e.g. \"r/technology\"." }, "subredditSubscribers": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subscriber count of the subreddit, when present." }, "subredditType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit access type, e.g. \"public\", \"restricted\", \"private\"." }, "linkFlairText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link flair label, if any." }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Source domain, e.g. \"self.technology\" or \"nytimes.com\"." }, "thumbnail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Thumbnail URL, or a sentinel like \"self\"/\"default\"/\"nsfw\" when there is no image." }, "distinguished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Distinguish state set by staff, e.g. \"moderator\" or \"admin\"; null for regular posts." }, "isSelf": { "type": "boolean", "description": "Whether this is a self (text) post." }, "isVideo": { "type": "boolean", "description": "Whether the post hosts a Reddit video." }, "isOriginalContent": { "type": "boolean", "description": "Whether the post is flagged as original content (OC)." }, "over18": { "type": "boolean", "description": "Whether the post is marked NSFW." }, "spoiler": { "type": "boolean", "description": "Whether the post is marked as a spoiler." }, "stickied": { "type": "boolean", "description": "Whether the post is pinned to the top of its subreddit feed." }, "pinned": { "type": "boolean", "description": "Whether the post is pinned to the author's profile." }, "archived": { "type": "boolean", "description": "Whether the post is archived (no longer accepts votes)." }, "contestMode": { "type": "boolean", "description": "Whether comments are shown in randomized contest-mode order." }, "locked": { "type": "boolean", "description": "Whether commenting is locked." }, "type": { "type": "string", "enum": [ "post" ] } }, "required": [ "id", "fullname", "title", "author", "authorFullname", "selftext", "score", "ups", "downs", "upvoteRatio", "numComments", "numCrossposts", "totalAwardsReceived", "gilded", "createdUtc", "createdAt", "editedUtc", "editedAt", "permalink", "postUrl", "url", "subreddit", "subredditId", "subredditUrl", "subredditPrefixed", "subredditSubscribers", "subredditType", "linkFlairText", "domain", "thumbnail", "distinguished", "isSelf", "isVideo", "isOriginalContent", "over18", "spoiler", "stickied", "pinned", "archived", "contestMode", "locked", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "Base-36 subreddit id without the `t5_` prefix, e.g. \"3b9u5\"." }, "fullname": { "type": "string", "description": "Reddit fullname including the prefix, e.g. \"t5_3b9u5\"." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name without prefix, e.g. \"OpenAI\"." }, "namePrefixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name with prefix, e.g. \"r/OpenAI\"." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit display title." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public, short description of the subreddit." }, "subscribers": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subscriber count." }, "over18": { "type": "boolean", "description": "Whether the subreddit is marked NSFW." }, "subredditType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Access type, e.g. \"public\", \"restricted\", \"private\"." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Site-relative path, e.g. \"/r/OpenAI/\"." }, "communityUrl": { "type": "string", "description": "Absolute URL to the subreddit on reddit.com." }, "iconUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Community icon (falls back to the legacy icon), if any." }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Banner image URL, if any." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Creation time as a Unix epoch in seconds." }, "type": { "type": "string", "enum": [ "community" ] } }, "required": [ "id", "fullname", "name", "namePrefixed", "title", "description", "subscribers", "over18", "subredditType", "url", "communityUrl", "iconUrl", "bannerUrl", "createdUtc", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "Base-36 account id without the `t2_` prefix, e.g. \"10knboj9s0\"." }, "username": { "type": "string", "description": "Reddit username, e.g. \"OpenAI\"." }, "profileUrl": { "type": "string", "description": "Absolute profile URL (https://www.reddit.com/user//)." }, "commentKarma": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Comment karma." }, "linkKarma": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Post (link) karma." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Account creation time as a Unix epoch in seconds." }, "iconUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile/snoovatar avatar URL, if any." }, "isGold": { "type": "boolean", "description": "Whether the account has Reddit Premium." }, "isMod": { "type": "boolean", "description": "Whether the account moderates any subreddit." }, "isEmployee": { "type": "boolean", "description": "Whether the account is a Reddit employee." }, "verified": { "type": "boolean", "description": "Whether the account is verified." }, "hasVerifiedEmail": { "type": "boolean", "description": "Whether the account has a verified email." }, "acceptFollowers": { "type": "boolean", "description": "Whether the account accepts followers." }, "type": { "type": "string", "enum": [ "user" ] } }, "required": [ "id", "username", "profileUrl", "commentKarma", "linkKarma", "createdUtc", "iconUrl", "isGold", "isMod", "isEmployee", "verified", "hasVerifiedEmail", "acceptFollowers", "type" ], "additionalProperties": false } ] }, "description": "Matching results across posts, communities, and users." }, "query": { "type": "string", "description": "The query string that was searched on Reddit." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (Reddit `after` fullname), or null when there are no more results." } }, "required": [ "results", "query", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.reddit.searchAll({\n query: \"string\",\n limit: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/reddit/search/communities": { "post": { "summary": "Search Reddit communities", "tags": [ "Reddit" ], "description": "Search Reddit for communities matching a phrase. Each result includes the subreddit name, title, description, subscriber count, icon and link. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "pattern": "\\S", "description": "The text to search Reddit for, e.g. \"openai\", \"best keyboard\"." }, "subreddit": { "description": "Restrict the search to a single subreddit (name with or without the \"r/\" prefix). Only applies to post search.", "type": "string" }, "sort": { "type": "string", "enum": [ "relevance", "hot", "top", "new", "comments" ], "description": "Result ordering. Defaults to \"relevance\"." }, "time": { "type": "string", "enum": [ "hour", "day", "week", "month", "year", "all" ], "description": "Restrict results to a recent window. Defaults to \"all\"." }, "after": { "description": "Pagination cursor (a Reddit fullname returned as `after` from a previous page).", "type": "string" }, "limit": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "query" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "communities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Base-36 subreddit id without the `t5_` prefix, e.g. \"3b9u5\"." }, "fullname": { "type": "string", "description": "Reddit fullname including the prefix, e.g. \"t5_3b9u5\"." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name without prefix, e.g. \"OpenAI\"." }, "namePrefixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name with prefix, e.g. \"r/OpenAI\"." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit display title." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public, short description of the subreddit." }, "subscribers": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subscriber count." }, "over18": { "type": "boolean", "description": "Whether the subreddit is marked NSFW." }, "subredditType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Access type, e.g. \"public\", \"restricted\", \"private\"." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Site-relative path, e.g. \"/r/OpenAI/\"." }, "communityUrl": { "type": "string", "description": "Absolute URL to the subreddit on reddit.com." }, "iconUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Community icon (falls back to the legacy icon), if any." }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Banner image URL, if any." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Creation time as a Unix epoch in seconds." } }, "required": [ "id", "fullname", "name", "namePrefixed", "title", "description", "subscribers", "over18", "subredditType", "url", "communityUrl", "iconUrl", "bannerUrl", "createdUtc" ], "additionalProperties": false }, "description": "Matching subreddits / communities." }, "query": { "type": "string", "description": "The query string that was searched on Reddit." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (Reddit `after` fullname), or null when there are no more results." } }, "required": [ "communities", "query", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.reddit.searchCommunities({\n query: \"string\",\n limit: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/reddit/search/posts": { "post": { "summary": "Search Reddit posts", "tags": [ "Reddit" ], "description": "Search Reddit posts by phrase, across all of Reddit or within one subreddit, sorted by relevance, hot, top, new or comment count. Each result includes the title, body, author, subreddit, score and comment count. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "pattern": "\\S", "description": "The text to search Reddit for, e.g. \"openai\", \"best keyboard\"." }, "subreddit": { "description": "Restrict the search to a single subreddit (name with or without the \"r/\" prefix). Only applies to post search.", "type": "string" }, "sort": { "type": "string", "enum": [ "relevance", "hot", "top", "new", "comments" ], "description": "Result ordering. Defaults to \"relevance\"." }, "time": { "type": "string", "enum": [ "hour", "day", "week", "month", "year", "all" ], "description": "Restrict results to a recent window. Defaults to \"all\"." }, "after": { "description": "Pagination cursor (a Reddit fullname returned as `after` from a previous page).", "type": "string" }, "limit": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "query" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Base-36 post id without the `t3_` prefix, e.g. \"1u3a0cd\"." }, "fullname": { "type": "string", "description": "Reddit fullname including the type prefix, e.g. \"t3_1u3a0cd\"." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Post title." }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author username, or \"[deleted]\" when removed." }, "authorFullname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author account fullname, e.g. \"t2_98wao505\"." }, "selftext": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-post body text (empty string for link posts)." }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Net score (upvotes minus downvotes)." }, "ups": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Upvote count (Reddit fuzzes this for large posts)." }, "downs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Downvote count (Reddit reports 0 on modern listings)." }, "upvoteRatio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Fraction of votes that are upvotes, 0–1." }, "numComments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total comment count." }, "numCrossposts": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times this post has been crossposted." }, "totalAwardsReceived": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of awards the post has received." }, "gilded": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post has been gilded (gold awards)." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Creation time as a Unix epoch in seconds." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Creation time as an ISO-8601 UTC string, e.g. \"2026-07-12T…Z\"." }, "editedUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Last edit time as a Unix epoch in seconds, or null if never edited." }, "editedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last edit time as an ISO-8601 UTC string, or null if never edited." }, "permalink": { "type": "string", "description": "Site-relative permalink path, e.g. \"/r/technology/comments/…\"." }, "postUrl": { "type": "string", "description": "Absolute URL to the post on reddit.com." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL the post points to — the external link for link posts, or the post permalink for self posts." }, "subreddit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name without prefix, e.g. \"technology\"." }, "subredditId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit fullname (stable `t5_` id), e.g. \"t5_2fwo\" — use to look the community up." }, "subredditUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the subreddit on reddit.com." }, "subredditPrefixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name with prefix, e.g. \"r/technology\"." }, "subredditSubscribers": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subscriber count of the subreddit, when present." }, "subredditType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit access type, e.g. \"public\", \"restricted\", \"private\"." }, "linkFlairText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link flair label, if any." }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Source domain, e.g. \"self.technology\" or \"nytimes.com\"." }, "thumbnail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Thumbnail URL, or a sentinel like \"self\"/\"default\"/\"nsfw\" when there is no image." }, "distinguished": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Distinguish state set by staff, e.g. \"moderator\" or \"admin\"; null for regular posts." }, "isSelf": { "type": "boolean", "description": "Whether this is a self (text) post." }, "isVideo": { "type": "boolean", "description": "Whether the post hosts a Reddit video." }, "isOriginalContent": { "type": "boolean", "description": "Whether the post is flagged as original content (OC)." }, "over18": { "type": "boolean", "description": "Whether the post is marked NSFW." }, "spoiler": { "type": "boolean", "description": "Whether the post is marked as a spoiler." }, "stickied": { "type": "boolean", "description": "Whether the post is pinned to the top of its subreddit feed." }, "pinned": { "type": "boolean", "description": "Whether the post is pinned to the author's profile." }, "archived": { "type": "boolean", "description": "Whether the post is archived (no longer accepts votes)." }, "contestMode": { "type": "boolean", "description": "Whether comments are shown in randomized contest-mode order." }, "locked": { "type": "boolean", "description": "Whether commenting is locked." } }, "required": [ "id", "fullname", "title", "author", "authorFullname", "selftext", "score", "ups", "downs", "upvoteRatio", "numComments", "numCrossposts", "totalAwardsReceived", "gilded", "createdUtc", "createdAt", "editedUtc", "editedAt", "permalink", "postUrl", "url", "subreddit", "subredditId", "subredditUrl", "subredditPrefixed", "subredditSubscribers", "subredditType", "linkFlairText", "domain", "thumbnail", "distinguished", "isSelf", "isVideo", "isOriginalContent", "over18", "spoiler", "stickied", "pinned", "archived", "contestMode", "locked" ], "additionalProperties": false }, "description": "Matching posts." }, "query": { "type": "string", "description": "The query string that was searched on Reddit." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (Reddit `after` fullname), or null when there are no more results." } }, "required": [ "posts", "query", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.reddit.searchPosts({\n query: \"string\",\n limit: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/reddit/search/users": { "post": { "summary": "Search Reddit users", "tags": [ "Reddit" ], "description": "Search Reddit for user accounts matching a phrase. Each result includes the username, karma, account creation date, avatar and profile link. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "pattern": "\\S", "description": "The text to search Reddit for, e.g. \"openai\", \"best keyboard\"." }, "subreddit": { "description": "Restrict the search to a single subreddit (name with or without the \"r/\" prefix). Only applies to post search.", "type": "string" }, "sort": { "type": "string", "enum": [ "relevance", "hot", "top", "new", "comments" ], "description": "Result ordering. Defaults to \"relevance\"." }, "time": { "type": "string", "enum": [ "hour", "day", "week", "month", "year", "all" ], "description": "Restrict results to a recent window. Defaults to \"all\"." }, "after": { "description": "Pagination cursor (a Reddit fullname returned as `after` from a previous page).", "type": "string" }, "limit": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "query" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Base-36 account id without the `t2_` prefix, e.g. \"10knboj9s0\"." }, "username": { "type": "string", "description": "Reddit username, e.g. \"OpenAI\"." }, "profileUrl": { "type": "string", "description": "Absolute profile URL (https://www.reddit.com/user//)." }, "commentKarma": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Comment karma." }, "linkKarma": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Post (link) karma." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Account creation time as a Unix epoch in seconds." }, "iconUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile/snoovatar avatar URL, if any." }, "isGold": { "type": "boolean", "description": "Whether the account has Reddit Premium." }, "isMod": { "type": "boolean", "description": "Whether the account moderates any subreddit." }, "isEmployee": { "type": "boolean", "description": "Whether the account is a Reddit employee." }, "verified": { "type": "boolean", "description": "Whether the account is verified." }, "hasVerifiedEmail": { "type": "boolean", "description": "Whether the account has a verified email." }, "acceptFollowers": { "type": "boolean", "description": "Whether the account accepts followers." } }, "required": [ "id", "username", "profileUrl", "commentKarma", "linkKarma", "createdUtc", "iconUrl", "isGold", "isMod", "isEmployee", "verified", "hasVerifiedEmail", "acceptFollowers" ], "additionalProperties": false }, "description": "Matching users." }, "query": { "type": "string", "description": "The query string that was searched on Reddit." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (Reddit `after` fullname), or null when there are no more results." } }, "required": [ "users", "query", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.reddit.searchUsers({\n query: \"string\",\n limit: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/reddit/search/comments": { "post": { "summary": "Search Reddit comments", "tags": [ "Reddit" ], "description": "Search Reddit comments by phrase. Each result includes the comment text and link along with the title and subreddit of the post it was left on. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "pattern": "\\S", "description": "The text to search Reddit for, e.g. \"openai\", \"best keyboard\"." }, "subreddit": { "description": "Restrict the search to a single subreddit (name with or without the \"r/\" prefix). Only applies to post search.", "type": "string" }, "sort": { "type": "string", "enum": [ "relevance", "hot", "top", "new", "comments" ], "description": "Result ordering. Defaults to \"relevance\"." }, "time": { "type": "string", "enum": [ "hour", "day", "week", "month", "year", "all" ], "description": "Restrict results to a recent window. Defaults to \"all\"." }, "after": { "description": "Pagination cursor (a Reddit fullname returned as `after` from a previous page).", "type": "string" }, "limit": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "query" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "comments": { "type": "array", "items": { "type": "object", "properties": { "commentId": { "type": "string", "description": "Base-36 comment id without the `t1_` prefix, e.g. \"owlhu2w\"." }, "commentFullname": { "type": "string", "description": "Comment fullname (stable `t1_` id), e.g. \"t1_owlhu2w\"." }, "permalink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Site-relative permalink path to the comment." }, "commentUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the comment on reddit.com." }, "parentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Base-36 id of the parent thing (a `t1_` comment for replies, otherwise the `t3_` post)." }, "parentFullname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Fullname of the parent thing — a `t1_` comment for replies, otherwise the `t3_` post the comment sits under." }, "postId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Base-36 id of the post the comment was left on, e.g. \"1us0dtr\" — use to look the post up." }, "postFullname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Post fullname (stable `t3_` id), e.g. \"t3_1us0dtr\"." }, "postTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Title of the post the comment was left on." }, "postPermalink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Site-relative permalink path to the post." }, "postUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the post on reddit.com." }, "postNsfw": { "type": "boolean", "description": "Whether the post is marked NSFW (over-18)." }, "postSpoiler": { "type": "boolean", "description": "Whether the post is marked as a spoiler." }, "subreddit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name without prefix, e.g. \"programming\"." }, "subredditId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit fullname (stable `t5_` id), e.g. \"t5_2fwo\" — use to look the community up." }, "subredditPrefixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subreddit name with prefix, e.g. \"r/programming\"." }, "subredditUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the subreddit on reddit.com." }, "subredditNsfw": { "type": "boolean", "description": "Whether the subreddit is marked NSFW (over-18)." }, "subredditQuarantined": { "type": "boolean", "description": "Whether the subreddit is quarantined." }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comment author username (without the \"u/\" prefix), or null if deleted." }, "authorUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL to the author's profile, or null if unavailable." }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The comment text (plain text)." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Creation time as an ISO-8601 UTC string, e.g. \"2026-07-09T23:37:55.274Z\"." }, "createdUtc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Creation time as a Unix epoch in seconds." } }, "required": [ "commentId", "commentFullname", "permalink", "commentUrl", "parentId", "parentFullname", "postId", "postFullname", "postTitle", "postPermalink", "postUrl", "postNsfw", "postSpoiler", "subreddit", "subredditId", "subredditPrefixed", "subredditUrl", "subredditNsfw", "subredditQuarantined", "author", "authorUrl", "body", "createdAt", "createdUtc" ], "additionalProperties": false }, "description": "Matching comments." }, "query": { "type": "string", "description": "The query string that was searched on Reddit." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (Reddit `after` fullname), or null when there are no more results." } }, "required": [ "comments", "query", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.reddit.searchComments({\n query: \"string\",\n limit: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/x/get-tweet-detail": { "post": { "summary": "Fetch a tweet with its reply thread", "tags": [ "X (Twitter)" ], "description": "Get a tweet by its ID together with the first page of replies beneath it. Returns the text, author, timestamp and like, retweet, reply, quote, bookmark and view counts for the tweet and each reply. Load more replies with `/x/get-tweet-replies`. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tweetId": { "type": "string", "pattern": "^\\d+$", "description": "Numeric ID of the tweet to fetch, e.g. \"1234567890\"." } }, "required": [ "tweetId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "replies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric tweet ID" }, "url": { "type": "string", "description": "Canonical tweet URL e.g. \"https://x.com/elonmusk/status/123\"" }, "text": { "type": "string", "description": "Full text of the tweet" }, "author": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string", "description": "Handle without the @ e.g. \"elonmusk\"" }, "profileUrl": { "type": "string", "description": "Canonical profile URL e.g. \"https://x.com/elonmusk\"" }, "displayName": { "type": "string" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile banner image URL" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-reported location" }, "followerCount": { "type": "number" }, "followingCount": { "type": "number" }, "tweetCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets posted (statuses_count)" }, "mediaCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of media items posted" }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets liked (favourites_count)" }, "listedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of lists the user appears on" }, "pinnedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric ID of the pinned tweet — resolve via the tweet endpoint" }, "pinnedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the pinned tweet" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "When the account was created" }, "createdAtEpochMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "When the account was created, as a Unix epoch in milliseconds" }, "isVerified": { "type": "boolean" }, "isBlueVerified": { "type": "boolean" } }, "required": [ "userId", "username", "profileUrl", "displayName", "bio", "avatarUrl", "bannerUrl", "location", "followerCount", "followingCount", "tweetCount", "mediaCount", "likeCount", "listedCount", "pinnedTweetId", "pinnedTweetUrl", "createdAt", "createdAtEpochMs", "isVerified", "isBlueVerified" ], "additionalProperties": false }, "createdAt": { "description": "When the tweet was posted", "type": "string", "format": "date-time" }, "createdAtEpochMs": { "type": "number", "description": "When the tweet was posted, as a Unix epoch in milliseconds" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Client app the tweet was posted from e.g. \"Twitter for iPhone\"" }, "conversationId": { "type": "string", "description": "ID of the root tweet in this thread" }, "replyCount": { "type": "number" }, "retweetCount": { "type": "number" }, "likeCount": { "type": "number" }, "quoteCount": { "type": "number" }, "bookmarkCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "viewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "replyToTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent tweet ID if this is a reply" }, "replyToUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author of the parent tweet" }, "replyToUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the parent tweet author if this is a reply" }, "replyToTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the parent tweet if this is a reply" }, "isQuote": { "type": "boolean", "description": "Whether this tweet quotes another tweet" }, "quotedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the quoted tweet — resolve via the tweet endpoint" }, "quotedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the quoted tweet" }, "quotedTweetAuthorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric user ID of the quoted tweet author" }, "quotedTweetAuthorUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the quoted tweet author" }, "retweetedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the original tweet when this entry is a retweet" }, "retweetedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the original tweet when this is a retweet" }, "retweetedTweetAuthorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric user ID of the original tweet author when a retweet" }, "retweetedTweetAuthorUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the original tweet author when a retweet" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Language code e.g. \"en\"" }, "isSensitive": { "type": "boolean" }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtag text without the # symbol" }, "mentions": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string" }, "displayName": { "type": "string" }, "profileUrl": { "type": "string", "description": "Canonical profile URL of the mentioned user" } }, "required": [ "userId", "username", "displayName", "profileUrl" ], "additionalProperties": false } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "shortUrl": { "type": "string", "description": "t.co short URL as it appears in the text" }, "expandedUrl": { "type": "string", "description": "The actual destination URL" }, "displayUrl": { "type": "string", "description": "Human-readable label e.g. \"github.com/...\"" } }, "required": [ "shortUrl", "expandedUrl", "displayUrl" ], "additionalProperties": false } }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "photo", "video", "animated_gif" ] }, "url": { "type": "string", "description": "Preview / thumbnail image URL (media_url_https)" }, "mediaKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable media identifier (media_key)" }, "mediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric media ID (id_str) — stable identifier of the media item" }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel width of the media; null when unknown" }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel height of the media; null when unknown" }, "expandedUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of this media on the tweet" }, "videoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Highest-quality MP4 URL for video / GIF media; null for photos" }, "durationMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video / GIF duration in milliseconds; null for photos" } }, "required": [ "type", "url", "mediaKey", "mediaId", "width", "height", "expandedUrl", "videoUrl", "durationMs" ], "additionalProperties": false } } }, "required": [ "id", "url", "text", "author", "createdAt", "createdAtEpochMs", "source", "conversationId", "replyCount", "retweetCount", "likeCount", "quoteCount", "bookmarkCount", "viewCount", "replyToTweetId", "replyToUserId", "replyToUsername", "replyToTweetUrl", "isQuote", "quotedTweetId", "quotedTweetUrl", "quotedTweetAuthorId", "quotedTweetAuthorUsername", "retweetedTweetId", "retweetedTweetUrl", "retweetedTweetAuthorId", "retweetedTweetAuthorUsername", "lang", "isSensitive", "hashtags", "mentions", "urls", "media" ], "additionalProperties": false }, "description": "Replies on this page, with the threads beneath them" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page of replies; pass it to `/x/get-tweet-replies` as `cursor`, null when there are no more" }, "tweet": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric tweet ID" }, "url": { "type": "string", "description": "Canonical tweet URL e.g. \"https://x.com/elonmusk/status/123\"" }, "text": { "type": "string", "description": "Full text of the tweet" }, "author": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string", "description": "Handle without the @ e.g. \"elonmusk\"" }, "profileUrl": { "type": "string", "description": "Canonical profile URL e.g. \"https://x.com/elonmusk\"" }, "displayName": { "type": "string" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile banner image URL" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-reported location" }, "followerCount": { "type": "number" }, "followingCount": { "type": "number" }, "tweetCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets posted (statuses_count)" }, "mediaCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of media items posted" }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets liked (favourites_count)" }, "listedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of lists the user appears on" }, "pinnedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric ID of the pinned tweet — resolve via the tweet endpoint" }, "pinnedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the pinned tweet" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "When the account was created" }, "createdAtEpochMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "When the account was created, as a Unix epoch in milliseconds" }, "isVerified": { "type": "boolean" }, "isBlueVerified": { "type": "boolean" } }, "required": [ "userId", "username", "profileUrl", "displayName", "bio", "avatarUrl", "bannerUrl", "location", "followerCount", "followingCount", "tweetCount", "mediaCount", "likeCount", "listedCount", "pinnedTweetId", "pinnedTweetUrl", "createdAt", "createdAtEpochMs", "isVerified", "isBlueVerified" ], "additionalProperties": false }, "createdAt": { "description": "When the tweet was posted", "type": "string", "format": "date-time" }, "createdAtEpochMs": { "type": "number", "description": "When the tweet was posted, as a Unix epoch in milliseconds" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Client app the tweet was posted from e.g. \"Twitter for iPhone\"" }, "conversationId": { "type": "string", "description": "ID of the root tweet in this thread" }, "replyCount": { "type": "number" }, "retweetCount": { "type": "number" }, "likeCount": { "type": "number" }, "quoteCount": { "type": "number" }, "bookmarkCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "viewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "replyToTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent tweet ID if this is a reply" }, "replyToUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author of the parent tweet" }, "replyToUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the parent tweet author if this is a reply" }, "replyToTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the parent tweet if this is a reply" }, "isQuote": { "type": "boolean", "description": "Whether this tweet quotes another tweet" }, "quotedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the quoted tweet — resolve via the tweet endpoint" }, "quotedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the quoted tweet" }, "quotedTweetAuthorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric user ID of the quoted tweet author" }, "quotedTweetAuthorUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the quoted tweet author" }, "retweetedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the original tweet when this entry is a retweet" }, "retweetedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the original tweet when this is a retweet" }, "retweetedTweetAuthorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric user ID of the original tweet author when a retweet" }, "retweetedTweetAuthorUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the original tweet author when a retweet" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Language code e.g. \"en\"" }, "isSensitive": { "type": "boolean" }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtag text without the # symbol" }, "mentions": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string" }, "displayName": { "type": "string" }, "profileUrl": { "type": "string", "description": "Canonical profile URL of the mentioned user" } }, "required": [ "userId", "username", "displayName", "profileUrl" ], "additionalProperties": false } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "shortUrl": { "type": "string", "description": "t.co short URL as it appears in the text" }, "expandedUrl": { "type": "string", "description": "The actual destination URL" }, "displayUrl": { "type": "string", "description": "Human-readable label e.g. \"github.com/...\"" } }, "required": [ "shortUrl", "expandedUrl", "displayUrl" ], "additionalProperties": false } }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "photo", "video", "animated_gif" ] }, "url": { "type": "string", "description": "Preview / thumbnail image URL (media_url_https)" }, "mediaKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable media identifier (media_key)" }, "mediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric media ID (id_str) — stable identifier of the media item" }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel width of the media; null when unknown" }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel height of the media; null when unknown" }, "expandedUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of this media on the tweet" }, "videoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Highest-quality MP4 URL for video / GIF media; null for photos" }, "durationMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video / GIF duration in milliseconds; null for photos" } }, "required": [ "type", "url", "mediaKey", "mediaId", "width", "height", "expandedUrl", "videoUrl", "durationMs" ], "additionalProperties": false } } }, "required": [ "id", "url", "text", "author", "createdAt", "createdAtEpochMs", "source", "conversationId", "replyCount", "retweetCount", "likeCount", "quoteCount", "bookmarkCount", "viewCount", "replyToTweetId", "replyToUserId", "replyToUsername", "replyToTweetUrl", "isQuote", "quotedTweetId", "quotedTweetUrl", "quotedTweetAuthorId", "quotedTweetAuthorUsername", "retweetedTweetId", "retweetedTweetUrl", "retweetedTweetAuthorId", "retweetedTweetAuthorUsername", "lang", "isSensitive", "hashtags", "mentions", "urls", "media" ], "additionalProperties": false } }, "required": [ "replies", "nextCursor", "tweet" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.x.getTweetDetail({\n tweetId: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/x/get-tweet-replies": { "post": { "summary": "List the replies to a tweet", "tags": [ "X (Twitter)" ], "description": "List the replies beneath a tweet, with the threads under each one. Returns the text, author, timestamp and engagement counts for each reply. Page through them with `cursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tweetId": { "type": "string", "pattern": "^\\d+$", "description": "Numeric ID of the tweet whose replies to list, e.g. \"1234567890\"." }, "cursor": { "description": "Pagination cursor from a previous response's `nextCursor` to fetch the next page.", "type": "string" } }, "required": [ "tweetId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "replies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric tweet ID" }, "url": { "type": "string", "description": "Canonical tweet URL e.g. \"https://x.com/elonmusk/status/123\"" }, "text": { "type": "string", "description": "Full text of the tweet" }, "author": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string", "description": "Handle without the @ e.g. \"elonmusk\"" }, "profileUrl": { "type": "string", "description": "Canonical profile URL e.g. \"https://x.com/elonmusk\"" }, "displayName": { "type": "string" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile banner image URL" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-reported location" }, "followerCount": { "type": "number" }, "followingCount": { "type": "number" }, "tweetCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets posted (statuses_count)" }, "mediaCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of media items posted" }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets liked (favourites_count)" }, "listedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of lists the user appears on" }, "pinnedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric ID of the pinned tweet — resolve via the tweet endpoint" }, "pinnedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the pinned tweet" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "When the account was created" }, "createdAtEpochMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "When the account was created, as a Unix epoch in milliseconds" }, "isVerified": { "type": "boolean" }, "isBlueVerified": { "type": "boolean" } }, "required": [ "userId", "username", "profileUrl", "displayName", "bio", "avatarUrl", "bannerUrl", "location", "followerCount", "followingCount", "tweetCount", "mediaCount", "likeCount", "listedCount", "pinnedTweetId", "pinnedTweetUrl", "createdAt", "createdAtEpochMs", "isVerified", "isBlueVerified" ], "additionalProperties": false }, "createdAt": { "description": "When the tweet was posted", "type": "string", "format": "date-time" }, "createdAtEpochMs": { "type": "number", "description": "When the tweet was posted, as a Unix epoch in milliseconds" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Client app the tweet was posted from e.g. \"Twitter for iPhone\"" }, "conversationId": { "type": "string", "description": "ID of the root tweet in this thread" }, "replyCount": { "type": "number" }, "retweetCount": { "type": "number" }, "likeCount": { "type": "number" }, "quoteCount": { "type": "number" }, "bookmarkCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "viewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "replyToTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent tweet ID if this is a reply" }, "replyToUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author of the parent tweet" }, "replyToUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the parent tweet author if this is a reply" }, "replyToTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the parent tweet if this is a reply" }, "isQuote": { "type": "boolean", "description": "Whether this tweet quotes another tweet" }, "quotedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the quoted tweet — resolve via the tweet endpoint" }, "quotedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the quoted tweet" }, "quotedTweetAuthorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric user ID of the quoted tweet author" }, "quotedTweetAuthorUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the quoted tweet author" }, "retweetedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the original tweet when this entry is a retweet" }, "retweetedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the original tweet when this is a retweet" }, "retweetedTweetAuthorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric user ID of the original tweet author when a retweet" }, "retweetedTweetAuthorUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the original tweet author when a retweet" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Language code e.g. \"en\"" }, "isSensitive": { "type": "boolean" }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtag text without the # symbol" }, "mentions": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string" }, "displayName": { "type": "string" }, "profileUrl": { "type": "string", "description": "Canonical profile URL of the mentioned user" } }, "required": [ "userId", "username", "displayName", "profileUrl" ], "additionalProperties": false } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "shortUrl": { "type": "string", "description": "t.co short URL as it appears in the text" }, "expandedUrl": { "type": "string", "description": "The actual destination URL" }, "displayUrl": { "type": "string", "description": "Human-readable label e.g. \"github.com/...\"" } }, "required": [ "shortUrl", "expandedUrl", "displayUrl" ], "additionalProperties": false } }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "photo", "video", "animated_gif" ] }, "url": { "type": "string", "description": "Preview / thumbnail image URL (media_url_https)" }, "mediaKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable media identifier (media_key)" }, "mediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric media ID (id_str) — stable identifier of the media item" }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel width of the media; null when unknown" }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel height of the media; null when unknown" }, "expandedUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of this media on the tweet" }, "videoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Highest-quality MP4 URL for video / GIF media; null for photos" }, "durationMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video / GIF duration in milliseconds; null for photos" } }, "required": [ "type", "url", "mediaKey", "mediaId", "width", "height", "expandedUrl", "videoUrl", "durationMs" ], "additionalProperties": false } } }, "required": [ "id", "url", "text", "author", "createdAt", "createdAtEpochMs", "source", "conversationId", "replyCount", "retweetCount", "likeCount", "quoteCount", "bookmarkCount", "viewCount", "replyToTweetId", "replyToUserId", "replyToUsername", "replyToTweetUrl", "isQuote", "quotedTweetId", "quotedTweetUrl", "quotedTweetAuthorId", "quotedTweetAuthorUsername", "retweetedTweetId", "retweetedTweetUrl", "retweetedTweetAuthorId", "retweetedTweetAuthorUsername", "lang", "isSensitive", "hashtags", "mentions", "urls", "media" ], "additionalProperties": false }, "description": "Replies on this page, with the threads beneath them" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page of replies; pass it to `/x/get-tweet-replies` as `cursor`, null when there are no more" } }, "required": [ "replies", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.x.getTweetReplies({\n tweetId: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/x/search": { "post": { "summary": "Search tweets with X advanced-search operators", "tags": [ "X (Twitter)" ], "description": "Search tweets with the same operators as X advanced search, such as from:, since:, min_faves: and lang:. Sort by latest or top and get each tweet's text, author, media, links and engagement counts. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "pattern": "\\S", "description": "Raw search query — supports all X advanced-search operators, e.g. \"openai lang:en\"." }, "withinHours": { "description": "Only return tweets newer than this many hours.", "type": "number", "exclusiveMinimum": 0 }, "count": { "default": 10, "description": "Most results to return per page (1–20). Defaults to 10. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 20 }, "cursor": { "description": "Pagination cursor from a previous response's `nextCursor` to fetch the next page.", "type": "string" }, "sortOrder": { "type": "string", "enum": [ "Latest", "Top" ], "description": "Result ordering: \"Latest\" = chronological newest-first (default), \"Top\" = X's engagement ranking." }, "lang": { "description": "BCP-47 language filter e.g. \"en\", \"ja\" (maps to `lang:XX`).", "type": "string", "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]+)?$" } }, "required": [ "query" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "tweets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric tweet ID" }, "url": { "type": "string", "description": "Canonical tweet URL e.g. \"https://x.com/elonmusk/status/123\"" }, "text": { "type": "string", "description": "Full text of the tweet" }, "createdAt": { "description": "When the tweet was posted", "type": "string", "format": "date-time" }, "createdAtEpochMs": { "type": "number", "description": "When the tweet was posted, as a Unix epoch in milliseconds" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Client app the tweet was posted from e.g. \"Twitter for iPhone\"" }, "conversationId": { "type": "string", "description": "ID of the root tweet in this thread" }, "replyCount": { "type": "number" }, "retweetCount": { "type": "number" }, "likeCount": { "type": "number" }, "quoteCount": { "type": "number" }, "bookmarkCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "viewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "replyToTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent tweet ID if this is a reply" }, "replyToUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author of the parent tweet" }, "replyToUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the parent tweet author if this is a reply" }, "replyToTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the parent tweet if this is a reply" }, "isQuote": { "type": "boolean", "description": "Whether this tweet quotes another tweet" }, "quotedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the quoted tweet — resolve via the tweet endpoint" }, "quotedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the quoted tweet" }, "quotedTweetAuthorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric user ID of the quoted tweet author" }, "quotedTweetAuthorUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the quoted tweet author" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Language code e.g. \"en\"" }, "isSensitive": { "type": "boolean" }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtag text without the # symbol" }, "mentions": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string" }, "displayName": { "type": "string" }, "profileUrl": { "type": "string", "description": "Canonical profile URL of the mentioned user" } }, "required": [ "userId", "username", "displayName", "profileUrl" ], "additionalProperties": false } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "shortUrl": { "type": "string", "description": "t.co short URL as it appears in the text" }, "expandedUrl": { "type": "string", "description": "The actual destination URL" }, "displayUrl": { "type": "string", "description": "Human-readable label e.g. \"github.com/...\"" } }, "required": [ "shortUrl", "expandedUrl", "displayUrl" ], "additionalProperties": false } }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "photo", "video", "animated_gif" ] }, "url": { "type": "string", "description": "Preview / thumbnail image URL (media_url_https)" }, "mediaKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable media identifier (media_key)" }, "mediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric media ID (id_str) — stable identifier of the media item" }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel width of the media; null when unknown" }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel height of the media; null when unknown" }, "expandedUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of this media on the tweet" }, "videoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Highest-quality MP4 URL for video / GIF media; null for photos" }, "durationMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video / GIF duration in milliseconds; null for photos" } }, "required": [ "type", "url", "mediaKey", "mediaId", "width", "height", "expandedUrl", "videoUrl", "durationMs" ], "additionalProperties": false } }, "authorId": { "type": "string", "description": "Numeric author user ID (rest_id) — resolve via the user endpoint" }, "authorHandle": { "type": "string", "description": "Author username without @" }, "authorName": { "type": "string", "description": "Author display name" }, "authorUrl": { "type": "string", "description": "Canonical author profile URL e.g. \"https://x.com/elonmusk\"" }, "authorIsVerified": { "type": "boolean", "description": "Legacy verified badge" }, "authorIsBlueVerified": { "type": "boolean", "description": "X Premium (blue) verified" } }, "required": [ "id", "url", "text", "createdAt", "createdAtEpochMs", "source", "conversationId", "replyCount", "retweetCount", "likeCount", "quoteCount", "bookmarkCount", "viewCount", "replyToTweetId", "replyToUserId", "replyToUsername", "replyToTweetUrl", "isQuote", "quotedTweetId", "quotedTweetUrl", "quotedTweetAuthorId", "quotedTweetAuthorUsername", "lang", "isSensitive", "hashtags", "mentions", "urls", "media", "authorId", "authorHandle", "authorName", "authorUrl", "authorIsVerified", "authorIsBlueVerified" ], "additionalProperties": false }, "description": "Matching tweets on this page" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page; pass it back as `cursor`, null when there are no more results" } }, "required": [ "tweets", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.x.search({\n query: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/x/search/users": { "post": { "summary": "Search X users", "tags": [ "X (Twitter)" ], "description": "Search X accounts by name or keyword. Each result includes the handle, display name, bio, location, website, avatar and follower, following and tweet counts. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "pattern": "\\S", "description": "Raw search query — supports all X advanced-search operators, e.g. \"openai lang:en\"." }, "cursor": { "description": "Pagination cursor from a previous response's `nextCursor` to fetch the next page.", "type": "string" }, "count": { "default": 10, "description": "Most results to return per page (1–20). Defaults to 10. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 20 } }, "required": [ "query" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string", "description": "Numeric user ID (rest_id)" }, "username": { "type": "string", "description": "Handle without the @ e.g. \"elonmusk\"" }, "profileUrl": { "type": "string", "description": "Canonical profile URL e.g. \"https://x.com/elonmusk\"" }, "displayName": { "type": "string", "description": "Profile display name" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile bio / description" }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL" }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile banner image URL" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-reported location" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Linked website (expanded URL)" }, "bioUrls": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Expanded destination URL of a link embedded in the bio text" }, "displayUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Shortened display form of the link e.g. \"example.com/books\"" } }, "required": [ "url", "displayUrl" ], "additionalProperties": false }, "description": "Expanded links embedded in the bio text; empty when none" }, "followerCount": { "type": "number", "description": "Number of followers" }, "followingCount": { "type": "number", "description": "Number of accounts followed" }, "fastFollowersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subset of followers counted as \"fast\" (spam-ish) followers" }, "normalFollowersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Followers excluding fast followers" }, "tweetCount": { "type": "number", "description": "Number of tweets posted (statuses_count)" }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets liked (favourites_count)" }, "mediaCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of media items posted" }, "listedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of lists the user appears on" }, "creatorSubscriptionsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of paid subscribers to this creator" }, "highlightedTweetsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets pinned to the profile Highlights tab" }, "pinnedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric ID of the pinned tweet — resolve via the tweet endpoint" }, "pinnedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the pinned tweet" }, "isVerified": { "type": "boolean", "description": "Legacy verified badge" }, "isBlueVerified": { "type": "boolean", "description": "X Premium (blue) verified" }, "verifiedType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Org verification tier e.g. \"Business\" or \"Government\"; null for personal accounts" }, "isIdentityVerified": { "type": "boolean", "description": "Whether the account passed X identity verification" }, "isProtected": { "type": "boolean", "description": "Whether the account is protected/private" }, "canDm": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the viewer can send this account a direct message" }, "professionalType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Professional account type e.g. \"Creator\" or \"Business\"" }, "professionalId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable id of the linked professional/business profile" }, "professionalCategoryId": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Stable professional category ID e.g. 580 for \"Media & News Company\"" }, "professionalCategoryName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Professional category label paired with professionalCategoryId" }, "affiliate": { "anyOf": [ { "type": "object", "properties": { "label": { "type": "string", "description": "Parent org display label e.g. \"X\" on an @X affiliate" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent org handle (without @) — resolve via the user endpoint" }, "profileUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the parent account this user is affiliated to" }, "badgeUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent org's badge image shown next to the affiliate" } }, "required": [ "label", "username", "profileUrl", "badgeUrl" ], "additionalProperties": false }, { "type": "null" } ], "description": "Parent org this account is a verified affiliate of, with its profile URL" }, "tipJar": { "anyOf": [ { "type": "object", "properties": { "isEnabled": { "type": "boolean", "description": "Whether the user has tipping enabled on their profile" }, "bitcoinHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Bitcoin wallet address the user accepts tips at" }, "ethereumHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ethereum wallet address the user accepts tips at" }, "venmoHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Venmo handle (without @)" }, "venmoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Venmo profile URL e.g. \"https://venmo.com/handle\"" }, "cashAppHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cash App cashtag (without $)" }, "cashAppUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Cash App URL e.g. \"https://cash.app/$handle\"" }, "patreonHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Patreon handle (without @)" }, "patreonUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Patreon URL e.g. \"https://www.patreon.com/handle\"" } }, "required": [ "isEnabled", "bitcoinHandle", "ethereumHandle", "venmoHandle", "venmoUrl", "cashAppHandle", "cashAppUrl", "patreonHandle", "patreonUrl" ], "additionalProperties": false }, { "type": "null" } ], "description": "External tip/payment handles (crypto wallets, Venmo/Cash App/Patreon) the user accepts tips at; null when none set" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "When the account was created" } }, "required": [ "userId", "username", "profileUrl", "displayName", "bio", "avatarUrl", "bannerUrl", "location", "websiteUrl", "bioUrls", "followerCount", "followingCount", "fastFollowersCount", "normalFollowersCount", "tweetCount", "likeCount", "mediaCount", "listedCount", "creatorSubscriptionsCount", "highlightedTweetsCount", "pinnedTweetId", "pinnedTweetUrl", "isVerified", "isBlueVerified", "verifiedType", "isIdentityVerified", "isProtected", "canDm", "professionalType", "professionalId", "professionalCategoryId", "professionalCategoryName", "affiliate", "tipJar", "createdAt" ], "additionalProperties": false }, "description": "Matching user profiles on this page, most relevant first" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page of results; pass it back as `cursor` to keep paging, null when the search is exhausted" } }, "required": [ "users", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.x.searchUsers({\n query: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/x/get-user": { "post": { "summary": "Fetch an X user profile by handle", "tags": [ "X (Twitter)" ], "description": "Get an X profile by handle: display name, bio, location, website, avatar and banner, follower, following, tweet and like counts, verification status, pinned tweet and join date. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "handle": { "type": "string", "pattern": "^\\s*@?[A-Za-z0-9_]+\\s*$", "description": "X handle / screen name, with or without the @, e.g. \"elonmusk\"." } }, "required": [ "handle" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "userId": { "type": "string", "description": "Numeric user ID (rest_id)" }, "username": { "type": "string", "description": "Handle without the @ e.g. \"elonmusk\"" }, "profileUrl": { "type": "string", "description": "Canonical profile URL e.g. \"https://x.com/elonmusk\"" }, "displayName": { "type": "string", "description": "Profile display name" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile bio / description" }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL" }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile banner image URL" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-reported location" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Linked website (expanded URL)" }, "bioUrls": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Expanded destination URL of a link embedded in the bio text" }, "displayUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Shortened display form of the link e.g. \"example.com/books\"" } }, "required": [ "url", "displayUrl" ], "additionalProperties": false }, "description": "Expanded links embedded in the bio text; empty when none" }, "followerCount": { "type": "number", "description": "Number of followers" }, "followingCount": { "type": "number", "description": "Number of accounts followed" }, "fastFollowersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subset of followers counted as \"fast\" (spam-ish) followers" }, "normalFollowersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Followers excluding fast followers" }, "tweetCount": { "type": "number", "description": "Number of tweets posted (statuses_count)" }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets liked (favourites_count)" }, "mediaCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of media items posted" }, "listedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of lists the user appears on" }, "creatorSubscriptionsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of paid subscribers to this creator" }, "highlightedTweetsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets pinned to the profile Highlights tab" }, "pinnedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric ID of the pinned tweet — resolve via the tweet endpoint" }, "pinnedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the pinned tweet" }, "isVerified": { "type": "boolean", "description": "Legacy verified badge" }, "isBlueVerified": { "type": "boolean", "description": "X Premium (blue) verified" }, "verifiedType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Org verification tier e.g. \"Business\" or \"Government\"; null for personal accounts" }, "isIdentityVerified": { "type": "boolean", "description": "Whether the account passed X identity verification" }, "isProtected": { "type": "boolean", "description": "Whether the account is protected/private" }, "canDm": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the viewer can send this account a direct message" }, "professionalType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Professional account type e.g. \"Creator\" or \"Business\"" }, "professionalId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable id of the linked professional/business profile" }, "professionalCategoryId": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Stable professional category ID e.g. 580 for \"Media & News Company\"" }, "professionalCategoryName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Professional category label paired with professionalCategoryId" }, "affiliate": { "anyOf": [ { "type": "object", "properties": { "label": { "type": "string", "description": "Parent org display label e.g. \"X\" on an @X affiliate" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent org handle (without @) — resolve via the user endpoint" }, "profileUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the parent account this user is affiliated to" }, "badgeUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent org's badge image shown next to the affiliate" } }, "required": [ "label", "username", "profileUrl", "badgeUrl" ], "additionalProperties": false }, { "type": "null" } ], "description": "Parent org this account is a verified affiliate of, with its profile URL" }, "tipJar": { "anyOf": [ { "type": "object", "properties": { "isEnabled": { "type": "boolean", "description": "Whether the user has tipping enabled on their profile" }, "bitcoinHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Bitcoin wallet address the user accepts tips at" }, "ethereumHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ethereum wallet address the user accepts tips at" }, "venmoHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Venmo handle (without @)" }, "venmoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Venmo profile URL e.g. \"https://venmo.com/handle\"" }, "cashAppHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cash App cashtag (without $)" }, "cashAppUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Cash App URL e.g. \"https://cash.app/$handle\"" }, "patreonHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Patreon handle (without @)" }, "patreonUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Patreon URL e.g. \"https://www.patreon.com/handle\"" } }, "required": [ "isEnabled", "bitcoinHandle", "ethereumHandle", "venmoHandle", "venmoUrl", "cashAppHandle", "cashAppUrl", "patreonHandle", "patreonUrl" ], "additionalProperties": false }, { "type": "null" } ], "description": "External tip/payment handles (crypto wallets, Venmo/Cash App/Patreon) the user accepts tips at; null when none set" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "When the account was created" } }, "required": [ "userId", "username", "profileUrl", "displayName", "bio", "avatarUrl", "bannerUrl", "location", "websiteUrl", "bioUrls", "followerCount", "followingCount", "fastFollowersCount", "normalFollowersCount", "tweetCount", "likeCount", "mediaCount", "listedCount", "creatorSubscriptionsCount", "highlightedTweetsCount", "pinnedTweetId", "pinnedTweetUrl", "isVerified", "isBlueVerified", "verifiedType", "isIdentityVerified", "isProtected", "canDm", "professionalType", "professionalId", "professionalCategoryId", "professionalCategoryName", "affiliate", "tipJar", "createdAt" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.x.getUser({\n handle: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/x/get-user-tweets": { "post": { "summary": "List an X user's tweets timeline", "tags": [ "X (Twitter)" ], "description": "List the tweets an X account has posted, using its numeric user ID from the user profile endpoint. Each tweet includes the text, timestamp, media and like, retweet, reply and view counts. Load older tweets with `cursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "pattern": "^\\d+$", "description": "Numeric user ID (rest_id) whose tweets to list, e.g. \"44196397\"." }, "cursor": { "description": "Pagination cursor from a previous response's `nextCursor` to fetch the next page.", "type": "string" } }, "required": [ "userId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "tweets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric tweet ID" }, "url": { "type": "string", "description": "Canonical tweet URL e.g. \"https://x.com/elonmusk/status/123\"" }, "text": { "type": "string", "description": "Full text of the tweet" }, "author": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string", "description": "Handle without the @ e.g. \"elonmusk\"" }, "profileUrl": { "type": "string", "description": "Canonical profile URL e.g. \"https://x.com/elonmusk\"" }, "displayName": { "type": "string" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile banner image URL" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-reported location" }, "followerCount": { "type": "number" }, "followingCount": { "type": "number" }, "tweetCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets posted (statuses_count)" }, "mediaCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of media items posted" }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets liked (favourites_count)" }, "listedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of lists the user appears on" }, "pinnedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric ID of the pinned tweet — resolve via the tweet endpoint" }, "pinnedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the pinned tweet" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "When the account was created" }, "createdAtEpochMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "When the account was created, as a Unix epoch in milliseconds" }, "isVerified": { "type": "boolean" }, "isBlueVerified": { "type": "boolean" } }, "required": [ "userId", "username", "profileUrl", "displayName", "bio", "avatarUrl", "bannerUrl", "location", "followerCount", "followingCount", "tweetCount", "mediaCount", "likeCount", "listedCount", "pinnedTweetId", "pinnedTweetUrl", "createdAt", "createdAtEpochMs", "isVerified", "isBlueVerified" ], "additionalProperties": false }, "createdAt": { "description": "When the tweet was posted", "type": "string", "format": "date-time" }, "createdAtEpochMs": { "type": "number", "description": "When the tweet was posted, as a Unix epoch in milliseconds" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Client app the tweet was posted from e.g. \"Twitter for iPhone\"" }, "conversationId": { "type": "string", "description": "ID of the root tweet in this thread" }, "replyCount": { "type": "number" }, "retweetCount": { "type": "number" }, "likeCount": { "type": "number" }, "quoteCount": { "type": "number" }, "bookmarkCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "viewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "replyToTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent tweet ID if this is a reply" }, "replyToUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author of the parent tweet" }, "replyToUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the parent tweet author if this is a reply" }, "replyToTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the parent tweet if this is a reply" }, "isQuote": { "type": "boolean", "description": "Whether this tweet quotes another tweet" }, "quotedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the quoted tweet — resolve via the tweet endpoint" }, "quotedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the quoted tweet" }, "quotedTweetAuthorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric user ID of the quoted tweet author" }, "quotedTweetAuthorUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the quoted tweet author" }, "retweetedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the original tweet when this entry is a retweet" }, "retweetedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the original tweet when this is a retweet" }, "retweetedTweetAuthorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric user ID of the original tweet author when a retweet" }, "retweetedTweetAuthorUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the original tweet author when a retweet" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Language code e.g. \"en\"" }, "isSensitive": { "type": "boolean" }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtag text without the # symbol" }, "mentions": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string" }, "displayName": { "type": "string" }, "profileUrl": { "type": "string", "description": "Canonical profile URL of the mentioned user" } }, "required": [ "userId", "username", "displayName", "profileUrl" ], "additionalProperties": false } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "shortUrl": { "type": "string", "description": "t.co short URL as it appears in the text" }, "expandedUrl": { "type": "string", "description": "The actual destination URL" }, "displayUrl": { "type": "string", "description": "Human-readable label e.g. \"github.com/...\"" } }, "required": [ "shortUrl", "expandedUrl", "displayUrl" ], "additionalProperties": false } }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "photo", "video", "animated_gif" ] }, "url": { "type": "string", "description": "Preview / thumbnail image URL (media_url_https)" }, "mediaKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable media identifier (media_key)" }, "mediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric media ID (id_str) — stable identifier of the media item" }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel width of the media; null when unknown" }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel height of the media; null when unknown" }, "expandedUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of this media on the tweet" }, "videoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Highest-quality MP4 URL for video / GIF media; null for photos" }, "durationMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video / GIF duration in milliseconds; null for photos" } }, "required": [ "type", "url", "mediaKey", "mediaId", "width", "height", "expandedUrl", "videoUrl", "durationMs" ], "additionalProperties": false } } }, "required": [ "id", "url", "text", "author", "createdAt", "createdAtEpochMs", "source", "conversationId", "replyCount", "retweetCount", "likeCount", "quoteCount", "bookmarkCount", "viewCount", "replyToTweetId", "replyToUserId", "replyToUsername", "replyToTweetUrl", "isQuote", "quotedTweetId", "quotedTweetUrl", "quotedTweetAuthorId", "quotedTweetAuthorUsername", "retweetedTweetId", "retweetedTweetUrl", "retweetedTweetAuthorId", "retweetedTweetAuthorUsername", "lang", "isSensitive", "hashtags", "mentions", "urls", "media" ], "additionalProperties": false }, "description": "Tweets on this page of the user timeline, newest first" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page; null when the timeline is exhausted" } }, "required": [ "tweets", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.x.getUserTweets({\n userId: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/x/get-user-replies": { "post": { "summary": "List an X user's replies", "tags": [ "X (Twitter)" ], "description": "List the replies an X account has posted to other tweets, using its numeric user ID. Each reply includes the text, the tweet it answers, timestamp and engagement counts. Load older replies with `cursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "pattern": "^\\d+$", "description": "Numeric user ID (rest_id) whose tweets to list, e.g. \"44196397\"." }, "cursor": { "description": "Pagination cursor from a previous response's `nextCursor` to fetch the next page.", "type": "string" } }, "required": [ "userId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "tweets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric tweet ID" }, "url": { "type": "string", "description": "Canonical tweet URL e.g. \"https://x.com/elonmusk/status/123\"" }, "text": { "type": "string", "description": "Full text of the tweet" }, "author": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string", "description": "Handle without the @ e.g. \"elonmusk\"" }, "profileUrl": { "type": "string", "description": "Canonical profile URL e.g. \"https://x.com/elonmusk\"" }, "displayName": { "type": "string" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile banner image URL" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-reported location" }, "followerCount": { "type": "number" }, "followingCount": { "type": "number" }, "tweetCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets posted (statuses_count)" }, "mediaCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of media items posted" }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets liked (favourites_count)" }, "listedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of lists the user appears on" }, "pinnedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric ID of the pinned tweet — resolve via the tweet endpoint" }, "pinnedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the pinned tweet" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "When the account was created" }, "createdAtEpochMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "When the account was created, as a Unix epoch in milliseconds" }, "isVerified": { "type": "boolean" }, "isBlueVerified": { "type": "boolean" } }, "required": [ "userId", "username", "profileUrl", "displayName", "bio", "avatarUrl", "bannerUrl", "location", "followerCount", "followingCount", "tweetCount", "mediaCount", "likeCount", "listedCount", "pinnedTweetId", "pinnedTweetUrl", "createdAt", "createdAtEpochMs", "isVerified", "isBlueVerified" ], "additionalProperties": false }, "createdAt": { "description": "When the tweet was posted", "type": "string", "format": "date-time" }, "createdAtEpochMs": { "type": "number", "description": "When the tweet was posted, as a Unix epoch in milliseconds" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Client app the tweet was posted from e.g. \"Twitter for iPhone\"" }, "conversationId": { "type": "string", "description": "ID of the root tweet in this thread" }, "replyCount": { "type": "number" }, "retweetCount": { "type": "number" }, "likeCount": { "type": "number" }, "quoteCount": { "type": "number" }, "bookmarkCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "viewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "replyToTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent tweet ID if this is a reply" }, "replyToUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author of the parent tweet" }, "replyToUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the parent tweet author if this is a reply" }, "replyToTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the parent tweet if this is a reply" }, "isQuote": { "type": "boolean", "description": "Whether this tweet quotes another tweet" }, "quotedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the quoted tweet — resolve via the tweet endpoint" }, "quotedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the quoted tweet" }, "quotedTweetAuthorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric user ID of the quoted tweet author" }, "quotedTweetAuthorUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the quoted tweet author" }, "retweetedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the original tweet when this entry is a retweet" }, "retweetedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the original tweet when this is a retweet" }, "retweetedTweetAuthorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric user ID of the original tweet author when a retweet" }, "retweetedTweetAuthorUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the original tweet author when a retweet" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Language code e.g. \"en\"" }, "isSensitive": { "type": "boolean" }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtag text without the # symbol" }, "mentions": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string" }, "displayName": { "type": "string" }, "profileUrl": { "type": "string", "description": "Canonical profile URL of the mentioned user" } }, "required": [ "userId", "username", "displayName", "profileUrl" ], "additionalProperties": false } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "shortUrl": { "type": "string", "description": "t.co short URL as it appears in the text" }, "expandedUrl": { "type": "string", "description": "The actual destination URL" }, "displayUrl": { "type": "string", "description": "Human-readable label e.g. \"github.com/...\"" } }, "required": [ "shortUrl", "expandedUrl", "displayUrl" ], "additionalProperties": false } }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "photo", "video", "animated_gif" ] }, "url": { "type": "string", "description": "Preview / thumbnail image URL (media_url_https)" }, "mediaKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable media identifier (media_key)" }, "mediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric media ID (id_str) — stable identifier of the media item" }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel width of the media; null when unknown" }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel height of the media; null when unknown" }, "expandedUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of this media on the tweet" }, "videoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Highest-quality MP4 URL for video / GIF media; null for photos" }, "durationMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video / GIF duration in milliseconds; null for photos" } }, "required": [ "type", "url", "mediaKey", "mediaId", "width", "height", "expandedUrl", "videoUrl", "durationMs" ], "additionalProperties": false } } }, "required": [ "id", "url", "text", "author", "createdAt", "createdAtEpochMs", "source", "conversationId", "replyCount", "retweetCount", "likeCount", "quoteCount", "bookmarkCount", "viewCount", "replyToTweetId", "replyToUserId", "replyToUsername", "replyToTweetUrl", "isQuote", "quotedTweetId", "quotedTweetUrl", "quotedTweetAuthorId", "quotedTweetAuthorUsername", "retweetedTweetId", "retweetedTweetUrl", "retweetedTweetAuthorId", "retweetedTweetAuthorUsername", "lang", "isSensitive", "hashtags", "mentions", "urls", "media" ], "additionalProperties": false }, "description": "Tweets on this page of the user timeline, newest first" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page; null when the timeline is exhausted" } }, "required": [ "tweets", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.x.getUserReplies({\n userId: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/x/get-user-media": { "post": { "summary": "List an X user's media tweets", "tags": [ "X (Twitter)" ], "description": "List the tweets with photos or videos an X account has posted, using its numeric user ID. Each tweet includes direct media links, the text, timestamp and engagement counts. Load older tweets with `cursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "pattern": "^\\d+$", "description": "Numeric user ID (rest_id) whose tweets to list, e.g. \"44196397\"." }, "cursor": { "description": "Pagination cursor from a previous response's `nextCursor` to fetch the next page.", "type": "string" }, "count": { "default": 10, "description": "Most results to return per page (1–100). Defaults to 10. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "userId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "tweets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric tweet ID" }, "url": { "type": "string", "description": "Canonical tweet URL e.g. \"https://x.com/elonmusk/status/123\"" }, "text": { "type": "string", "description": "Full text of the tweet" }, "author": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string", "description": "Handle without the @ e.g. \"elonmusk\"" }, "profileUrl": { "type": "string", "description": "Canonical profile URL e.g. \"https://x.com/elonmusk\"" }, "displayName": { "type": "string" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile banner image URL" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-reported location" }, "followerCount": { "type": "number" }, "followingCount": { "type": "number" }, "tweetCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets posted (statuses_count)" }, "mediaCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of media items posted" }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets liked (favourites_count)" }, "listedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of lists the user appears on" }, "pinnedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric ID of the pinned tweet — resolve via the tweet endpoint" }, "pinnedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the pinned tweet" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "When the account was created" }, "createdAtEpochMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "When the account was created, as a Unix epoch in milliseconds" }, "isVerified": { "type": "boolean" }, "isBlueVerified": { "type": "boolean" } }, "required": [ "userId", "username", "profileUrl", "displayName", "bio", "avatarUrl", "bannerUrl", "location", "followerCount", "followingCount", "tweetCount", "mediaCount", "likeCount", "listedCount", "pinnedTweetId", "pinnedTweetUrl", "createdAt", "createdAtEpochMs", "isVerified", "isBlueVerified" ], "additionalProperties": false }, "createdAt": { "description": "When the tweet was posted", "type": "string", "format": "date-time" }, "createdAtEpochMs": { "type": "number", "description": "When the tweet was posted, as a Unix epoch in milliseconds" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Client app the tweet was posted from e.g. \"Twitter for iPhone\"" }, "conversationId": { "type": "string", "description": "ID of the root tweet in this thread" }, "replyCount": { "type": "number" }, "retweetCount": { "type": "number" }, "likeCount": { "type": "number" }, "quoteCount": { "type": "number" }, "bookmarkCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "viewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "replyToTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent tweet ID if this is a reply" }, "replyToUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author of the parent tweet" }, "replyToUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the parent tweet author if this is a reply" }, "replyToTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the parent tweet if this is a reply" }, "isQuote": { "type": "boolean", "description": "Whether this tweet quotes another tweet" }, "quotedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the quoted tweet — resolve via the tweet endpoint" }, "quotedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the quoted tweet" }, "quotedTweetAuthorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric user ID of the quoted tweet author" }, "quotedTweetAuthorUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the quoted tweet author" }, "retweetedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the original tweet when this entry is a retweet" }, "retweetedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the original tweet when this is a retweet" }, "retweetedTweetAuthorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric user ID of the original tweet author when a retweet" }, "retweetedTweetAuthorUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the original tweet author when a retweet" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Language code e.g. \"en\"" }, "isSensitive": { "type": "boolean" }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtag text without the # symbol" }, "mentions": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string" }, "displayName": { "type": "string" }, "profileUrl": { "type": "string", "description": "Canonical profile URL of the mentioned user" } }, "required": [ "userId", "username", "displayName", "profileUrl" ], "additionalProperties": false } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "shortUrl": { "type": "string", "description": "t.co short URL as it appears in the text" }, "expandedUrl": { "type": "string", "description": "The actual destination URL" }, "displayUrl": { "type": "string", "description": "Human-readable label e.g. \"github.com/...\"" } }, "required": [ "shortUrl", "expandedUrl", "displayUrl" ], "additionalProperties": false } }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "photo", "video", "animated_gif" ] }, "url": { "type": "string", "description": "Preview / thumbnail image URL (media_url_https)" }, "mediaKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable media identifier (media_key)" }, "mediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric media ID (id_str) — stable identifier of the media item" }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel width of the media; null when unknown" }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel height of the media; null when unknown" }, "expandedUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of this media on the tweet" }, "videoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Highest-quality MP4 URL for video / GIF media; null for photos" }, "durationMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video / GIF duration in milliseconds; null for photos" } }, "required": [ "type", "url", "mediaKey", "mediaId", "width", "height", "expandedUrl", "videoUrl", "durationMs" ], "additionalProperties": false } } }, "required": [ "id", "url", "text", "author", "createdAt", "createdAtEpochMs", "source", "conversationId", "replyCount", "retweetCount", "likeCount", "quoteCount", "bookmarkCount", "viewCount", "replyToTweetId", "replyToUserId", "replyToUsername", "replyToTweetUrl", "isQuote", "quotedTweetId", "quotedTweetUrl", "quotedTweetAuthorId", "quotedTweetAuthorUsername", "retweetedTweetId", "retweetedTweetUrl", "retweetedTweetAuthorId", "retweetedTweetAuthorUsername", "lang", "isSensitive", "hashtags", "mentions", "urls", "media" ], "additionalProperties": false }, "description": "Tweets on this page of the user timeline, newest first" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page; null when the timeline is exhausted" } }, "required": [ "tweets", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.x.getUserMedia({\n userId: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/x/get-followers": { "post": { "summary": "List an X user's followers", "tags": [ "X (Twitter)" ], "description": "List the accounts that follow an X user, using its numeric user ID. Each follower includes the handle, display name, bio, location and follower and following counts. Page through the list with `cursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "pattern": "^\\d+$", "description": "Numeric user ID (rest_id) whose tweets to list, e.g. \"44196397\"." }, "cursor": { "description": "Pagination cursor from a previous response's `nextCursor` to fetch the next page.", "type": "string" } }, "required": [ "userId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string", "description": "Numeric user ID (rest_id)" }, "username": { "type": "string", "description": "Handle without the @ e.g. \"elonmusk\"" }, "profileUrl": { "type": "string", "description": "Canonical profile URL e.g. \"https://x.com/elonmusk\"" }, "displayName": { "type": "string", "description": "Profile display name" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile bio / description" }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL" }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile banner image URL" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-reported location" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Linked website (expanded URL)" }, "bioUrls": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Expanded destination URL of a link embedded in the bio text" }, "displayUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Shortened display form of the link e.g. \"example.com/books\"" } }, "required": [ "url", "displayUrl" ], "additionalProperties": false }, "description": "Expanded links embedded in the bio text; empty when none" }, "followerCount": { "type": "number", "description": "Number of followers" }, "followingCount": { "type": "number", "description": "Number of accounts followed" }, "fastFollowersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subset of followers counted as \"fast\" (spam-ish) followers" }, "normalFollowersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Followers excluding fast followers" }, "tweetCount": { "type": "number", "description": "Number of tweets posted (statuses_count)" }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets liked (favourites_count)" }, "mediaCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of media items posted" }, "listedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of lists the user appears on" }, "creatorSubscriptionsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of paid subscribers to this creator" }, "highlightedTweetsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets pinned to the profile Highlights tab" }, "pinnedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric ID of the pinned tweet — resolve via the tweet endpoint" }, "pinnedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the pinned tweet" }, "isVerified": { "type": "boolean", "description": "Legacy verified badge" }, "isBlueVerified": { "type": "boolean", "description": "X Premium (blue) verified" }, "verifiedType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Org verification tier e.g. \"Business\" or \"Government\"; null for personal accounts" }, "isIdentityVerified": { "type": "boolean", "description": "Whether the account passed X identity verification" }, "isProtected": { "type": "boolean", "description": "Whether the account is protected/private" }, "canDm": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the viewer can send this account a direct message" }, "professionalType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Professional account type e.g. \"Creator\" or \"Business\"" }, "professionalId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable id of the linked professional/business profile" }, "professionalCategoryId": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Stable professional category ID e.g. 580 for \"Media & News Company\"" }, "professionalCategoryName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Professional category label paired with professionalCategoryId" }, "affiliate": { "anyOf": [ { "type": "object", "properties": { "label": { "type": "string", "description": "Parent org display label e.g. \"X\" on an @X affiliate" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent org handle (without @) — resolve via the user endpoint" }, "profileUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the parent account this user is affiliated to" }, "badgeUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent org's badge image shown next to the affiliate" } }, "required": [ "label", "username", "profileUrl", "badgeUrl" ], "additionalProperties": false }, { "type": "null" } ], "description": "Parent org this account is a verified affiliate of, with its profile URL" }, "tipJar": { "anyOf": [ { "type": "object", "properties": { "isEnabled": { "type": "boolean", "description": "Whether the user has tipping enabled on their profile" }, "bitcoinHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Bitcoin wallet address the user accepts tips at" }, "ethereumHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ethereum wallet address the user accepts tips at" }, "venmoHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Venmo handle (without @)" }, "venmoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Venmo profile URL e.g. \"https://venmo.com/handle\"" }, "cashAppHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cash App cashtag (without $)" }, "cashAppUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Cash App URL e.g. \"https://cash.app/$handle\"" }, "patreonHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Patreon handle (without @)" }, "patreonUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Patreon URL e.g. \"https://www.patreon.com/handle\"" } }, "required": [ "isEnabled", "bitcoinHandle", "ethereumHandle", "venmoHandle", "venmoUrl", "cashAppHandle", "cashAppUrl", "patreonHandle", "patreonUrl" ], "additionalProperties": false }, { "type": "null" } ], "description": "External tip/payment handles (crypto wallets, Venmo/Cash App/Patreon) the user accepts tips at; null when none set" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "When the account was created" } }, "required": [ "userId", "username", "profileUrl", "displayName", "bio", "avatarUrl", "bannerUrl", "location", "websiteUrl", "bioUrls", "followerCount", "followingCount", "fastFollowersCount", "normalFollowersCount", "tweetCount", "likeCount", "mediaCount", "listedCount", "creatorSubscriptionsCount", "highlightedTweetsCount", "pinnedTweetId", "pinnedTweetUrl", "isVerified", "isBlueVerified", "verifiedType", "isIdentityVerified", "isProtected", "canDm", "professionalType", "professionalId", "professionalCategoryId", "professionalCategoryName", "affiliate", "tipJar", "createdAt" ], "additionalProperties": false }, "description": "Follower profiles on this page, most recent follower first" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page; null when the follower list is exhausted" } }, "required": [ "users", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.x.getFollowers({\n userId: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/x/get-following": { "post": { "summary": "List the accounts an X user follows", "tags": [ "X (Twitter)" ], "description": "List the accounts an X user follows, using its numeric user ID. Each account includes the handle, display name, bio, location and follower and following counts. Page through the list with `cursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "pattern": "^\\d+$", "description": "Numeric user ID (rest_id) whose tweets to list, e.g. \"44196397\"." }, "cursor": { "description": "Pagination cursor from a previous response's `nextCursor` to fetch the next page.", "type": "string" } }, "required": [ "userId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string", "description": "Numeric user ID (rest_id)" }, "username": { "type": "string", "description": "Handle without the @ e.g. \"elonmusk\"" }, "profileUrl": { "type": "string", "description": "Canonical profile URL e.g. \"https://x.com/elonmusk\"" }, "displayName": { "type": "string", "description": "Profile display name" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile bio / description" }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL" }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile banner image URL" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-reported location" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Linked website (expanded URL)" }, "bioUrls": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Expanded destination URL of a link embedded in the bio text" }, "displayUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Shortened display form of the link e.g. \"example.com/books\"" } }, "required": [ "url", "displayUrl" ], "additionalProperties": false }, "description": "Expanded links embedded in the bio text; empty when none" }, "followerCount": { "type": "number", "description": "Number of followers" }, "followingCount": { "type": "number", "description": "Number of accounts followed" }, "fastFollowersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subset of followers counted as \"fast\" (spam-ish) followers" }, "normalFollowersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Followers excluding fast followers" }, "tweetCount": { "type": "number", "description": "Number of tweets posted (statuses_count)" }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets liked (favourites_count)" }, "mediaCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of media items posted" }, "listedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of lists the user appears on" }, "creatorSubscriptionsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of paid subscribers to this creator" }, "highlightedTweetsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets pinned to the profile Highlights tab" }, "pinnedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric ID of the pinned tweet — resolve via the tweet endpoint" }, "pinnedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the pinned tweet" }, "isVerified": { "type": "boolean", "description": "Legacy verified badge" }, "isBlueVerified": { "type": "boolean", "description": "X Premium (blue) verified" }, "verifiedType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Org verification tier e.g. \"Business\" or \"Government\"; null for personal accounts" }, "isIdentityVerified": { "type": "boolean", "description": "Whether the account passed X identity verification" }, "isProtected": { "type": "boolean", "description": "Whether the account is protected/private" }, "canDm": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the viewer can send this account a direct message" }, "professionalType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Professional account type e.g. \"Creator\" or \"Business\"" }, "professionalId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable id of the linked professional/business profile" }, "professionalCategoryId": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Stable professional category ID e.g. 580 for \"Media & News Company\"" }, "professionalCategoryName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Professional category label paired with professionalCategoryId" }, "affiliate": { "anyOf": [ { "type": "object", "properties": { "label": { "type": "string", "description": "Parent org display label e.g. \"X\" on an @X affiliate" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent org handle (without @) — resolve via the user endpoint" }, "profileUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the parent account this user is affiliated to" }, "badgeUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent org's badge image shown next to the affiliate" } }, "required": [ "label", "username", "profileUrl", "badgeUrl" ], "additionalProperties": false }, { "type": "null" } ], "description": "Parent org this account is a verified affiliate of, with its profile URL" }, "tipJar": { "anyOf": [ { "type": "object", "properties": { "isEnabled": { "type": "boolean", "description": "Whether the user has tipping enabled on their profile" }, "bitcoinHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Bitcoin wallet address the user accepts tips at" }, "ethereumHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ethereum wallet address the user accepts tips at" }, "venmoHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Venmo handle (without @)" }, "venmoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Venmo profile URL e.g. \"https://venmo.com/handle\"" }, "cashAppHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cash App cashtag (without $)" }, "cashAppUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Cash App URL e.g. \"https://cash.app/$handle\"" }, "patreonHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Patreon handle (without @)" }, "patreonUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Patreon URL e.g. \"https://www.patreon.com/handle\"" } }, "required": [ "isEnabled", "bitcoinHandle", "ethereumHandle", "venmoHandle", "venmoUrl", "cashAppHandle", "cashAppUrl", "patreonHandle", "patreonUrl" ], "additionalProperties": false }, { "type": "null" } ], "description": "External tip/payment handles (crypto wallets, Venmo/Cash App/Patreon) the user accepts tips at; null when none set" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "When the account was created" } }, "required": [ "userId", "username", "profileUrl", "displayName", "bio", "avatarUrl", "bannerUrl", "location", "websiteUrl", "bioUrls", "followerCount", "followingCount", "fastFollowersCount", "normalFollowersCount", "tweetCount", "likeCount", "mediaCount", "listedCount", "creatorSubscriptionsCount", "highlightedTweetsCount", "pinnedTweetId", "pinnedTweetUrl", "isVerified", "isBlueVerified", "verifiedType", "isIdentityVerified", "isProtected", "canDm", "professionalType", "professionalId", "professionalCategoryId", "professionalCategoryName", "affiliate", "tipJar", "createdAt" ], "additionalProperties": false }, "description": "Accounts this user follows on this page, most recent first" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page; null when the following list is exhausted" } }, "required": [ "users", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.x.getFollowing({\n userId: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/x/get-tweet-retweeters": { "post": { "summary": "List the users who retweeted a tweet", "tags": [ "X (Twitter)" ], "description": "List the accounts that retweeted a tweet, with each account's handle, display name, bio and follower and following counts. Page through the list with `cursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "Pagination cursor from a previous response's `nextCursor` to fetch the next page.", "type": "string" }, "tweetId": { "type": "string", "pattern": "^\\d+$", "description": "Numeric ID of the tweet whose retweeters to list, e.g. \"1234567890\"." }, "count": { "default": 10, "description": "Most results to return per page (1–100). Defaults to 10. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "tweetId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string", "description": "Numeric user ID (rest_id)" }, "username": { "type": "string", "description": "Handle without the @ e.g. \"elonmusk\"" }, "profileUrl": { "type": "string", "description": "Canonical profile URL e.g. \"https://x.com/elonmusk\"" }, "displayName": { "type": "string", "description": "Profile display name" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile bio / description" }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL" }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile banner image URL" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Self-reported location" }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Linked website (expanded URL)" }, "bioUrls": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Expanded destination URL of a link embedded in the bio text" }, "displayUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Shortened display form of the link e.g. \"example.com/books\"" } }, "required": [ "url", "displayUrl" ], "additionalProperties": false }, "description": "Expanded links embedded in the bio text; empty when none" }, "followerCount": { "type": "number", "description": "Number of followers" }, "followingCount": { "type": "number", "description": "Number of accounts followed" }, "fastFollowersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Subset of followers counted as \"fast\" (spam-ish) followers" }, "normalFollowersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Followers excluding fast followers" }, "tweetCount": { "type": "number", "description": "Number of tweets posted (statuses_count)" }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets liked (favourites_count)" }, "mediaCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of media items posted" }, "listedCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of lists the user appears on" }, "creatorSubscriptionsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of paid subscribers to this creator" }, "highlightedTweetsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of tweets pinned to the profile Highlights tab" }, "pinnedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric ID of the pinned tweet — resolve via the tweet endpoint" }, "pinnedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the pinned tweet" }, "isVerified": { "type": "boolean", "description": "Legacy verified badge" }, "isBlueVerified": { "type": "boolean", "description": "X Premium (blue) verified" }, "verifiedType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Org verification tier e.g. \"Business\" or \"Government\"; null for personal accounts" }, "isIdentityVerified": { "type": "boolean", "description": "Whether the account passed X identity verification" }, "isProtected": { "type": "boolean", "description": "Whether the account is protected/private" }, "canDm": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the viewer can send this account a direct message" }, "professionalType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Professional account type e.g. \"Creator\" or \"Business\"" }, "professionalId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable id of the linked professional/business profile" }, "professionalCategoryId": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Stable professional category ID e.g. 580 for \"Media & News Company\"" }, "professionalCategoryName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Professional category label paired with professionalCategoryId" }, "affiliate": { "anyOf": [ { "type": "object", "properties": { "label": { "type": "string", "description": "Parent org display label e.g. \"X\" on an @X affiliate" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent org handle (without @) — resolve via the user endpoint" }, "profileUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the parent account this user is affiliated to" }, "badgeUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent org's badge image shown next to the affiliate" } }, "required": [ "label", "username", "profileUrl", "badgeUrl" ], "additionalProperties": false }, { "type": "null" } ], "description": "Parent org this account is a verified affiliate of, with its profile URL" }, "tipJar": { "anyOf": [ { "type": "object", "properties": { "isEnabled": { "type": "boolean", "description": "Whether the user has tipping enabled on their profile" }, "bitcoinHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Bitcoin wallet address the user accepts tips at" }, "ethereumHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ethereum wallet address the user accepts tips at" }, "venmoHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Venmo handle (without @)" }, "venmoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Venmo profile URL e.g. \"https://venmo.com/handle\"" }, "cashAppHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cash App cashtag (without $)" }, "cashAppUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Cash App URL e.g. \"https://cash.app/$handle\"" }, "patreonHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Patreon handle (without @)" }, "patreonUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Patreon URL e.g. \"https://www.patreon.com/handle\"" } }, "required": [ "isEnabled", "bitcoinHandle", "ethereumHandle", "venmoHandle", "venmoUrl", "cashAppHandle", "cashAppUrl", "patreonHandle", "patreonUrl" ], "additionalProperties": false }, { "type": "null" } ], "description": "External tip/payment handles (crypto wallets, Venmo/Cash App/Patreon) the user accepts tips at; null when none set" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "When the account was created" } }, "required": [ "userId", "username", "profileUrl", "displayName", "bio", "avatarUrl", "bannerUrl", "location", "websiteUrl", "bioUrls", "followerCount", "followingCount", "fastFollowersCount", "normalFollowersCount", "tweetCount", "likeCount", "mediaCount", "listedCount", "creatorSubscriptionsCount", "highlightedTweetsCount", "pinnedTweetId", "pinnedTweetUrl", "isVerified", "isBlueVerified", "verifiedType", "isIdentityVerified", "isProtected", "canDm", "professionalType", "professionalId", "professionalCategoryId", "professionalCategoryName", "affiliate", "tipJar", "createdAt" ], "additionalProperties": false }, "description": "Users who retweeted the tweet on this page, most recent first" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page; null when the retweeter list is exhausted" } }, "required": [ "users", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.x.getTweetRetweeters({\n tweetId: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/x/get-tweet-quotes": { "post": { "summary": "List quote tweets of a tweet", "tags": [ "X (Twitter)" ], "description": "List the quote tweets of a tweet, the posts that shared it with added commentary, sorted by latest or top. Each includes the text, author, media and engagement counts. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tweetId": { "type": "string", "pattern": "^\\d+$", "description": "Numeric ID of the tweet whose quote tweets to list, e.g. \"1234567890\"." }, "count": { "default": 10, "description": "Most results to return per page (1–20). Defaults to 10. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 20 }, "cursor": { "description": "Pagination cursor from a previous response's `nextCursor` to fetch the next page.", "type": "string" }, "sortOrder": { "type": "string", "enum": [ "Latest", "Top" ], "description": "Result ordering: \"Latest\" = chronological newest-first (default), \"Top\" = X's engagement ranking." } }, "required": [ "tweetId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "tweets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric tweet ID" }, "url": { "type": "string", "description": "Canonical tweet URL e.g. \"https://x.com/elonmusk/status/123\"" }, "text": { "type": "string", "description": "Full text of the tweet" }, "createdAt": { "description": "When the tweet was posted", "type": "string", "format": "date-time" }, "createdAtEpochMs": { "type": "number", "description": "When the tweet was posted, as a Unix epoch in milliseconds" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Client app the tweet was posted from e.g. \"Twitter for iPhone\"" }, "conversationId": { "type": "string", "description": "ID of the root tweet in this thread" }, "replyCount": { "type": "number" }, "retweetCount": { "type": "number" }, "likeCount": { "type": "number" }, "quoteCount": { "type": "number" }, "bookmarkCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "viewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "replyToTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent tweet ID if this is a reply" }, "replyToUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Author of the parent tweet" }, "replyToUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the parent tweet author if this is a reply" }, "replyToTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the parent tweet if this is a reply" }, "isQuote": { "type": "boolean", "description": "Whether this tweet quotes another tweet" }, "quotedTweetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the quoted tweet — resolve via the tweet endpoint" }, "quotedTweetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of the quoted tweet" }, "quotedTweetAuthorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric user ID of the quoted tweet author" }, "quotedTweetAuthorUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle of the quoted tweet author" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Language code e.g. \"en\"" }, "isSensitive": { "type": "boolean" }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtag text without the # symbol" }, "mentions": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "username": { "type": "string" }, "displayName": { "type": "string" }, "profileUrl": { "type": "string", "description": "Canonical profile URL of the mentioned user" } }, "required": [ "userId", "username", "displayName", "profileUrl" ], "additionalProperties": false } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "shortUrl": { "type": "string", "description": "t.co short URL as it appears in the text" }, "expandedUrl": { "type": "string", "description": "The actual destination URL" }, "displayUrl": { "type": "string", "description": "Human-readable label e.g. \"github.com/...\"" } }, "required": [ "shortUrl", "expandedUrl", "displayUrl" ], "additionalProperties": false } }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "photo", "video", "animated_gif" ] }, "url": { "type": "string", "description": "Preview / thumbnail image URL (media_url_https)" }, "mediaKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable media identifier (media_key)" }, "mediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Numeric media ID (id_str) — stable identifier of the media item" }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel width of the media; null when unknown" }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Native pixel height of the media; null when unknown" }, "expandedUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical URL of this media on the tweet" }, "videoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Highest-quality MP4 URL for video / GIF media; null for photos" }, "durationMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video / GIF duration in milliseconds; null for photos" } }, "required": [ "type", "url", "mediaKey", "mediaId", "width", "height", "expandedUrl", "videoUrl", "durationMs" ], "additionalProperties": false } }, "authorId": { "type": "string", "description": "Numeric author user ID (rest_id) — resolve via the user endpoint" }, "authorHandle": { "type": "string", "description": "Author username without @" }, "authorName": { "type": "string", "description": "Author display name" }, "authorUrl": { "type": "string", "description": "Canonical author profile URL e.g. \"https://x.com/elonmusk\"" }, "authorIsVerified": { "type": "boolean", "description": "Legacy verified badge" }, "authorIsBlueVerified": { "type": "boolean", "description": "X Premium (blue) verified" } }, "required": [ "id", "url", "text", "createdAt", "createdAtEpochMs", "source", "conversationId", "replyCount", "retweetCount", "likeCount", "quoteCount", "bookmarkCount", "viewCount", "replyToTweetId", "replyToUserId", "replyToUsername", "replyToTweetUrl", "isQuote", "quotedTweetId", "quotedTweetUrl", "quotedTweetAuthorId", "quotedTweetAuthorUsername", "lang", "isSensitive", "hashtags", "mentions", "urls", "media", "authorId", "authorHandle", "authorName", "authorUrl", "authorIsVerified", "authorIsBlueVerified" ], "additionalProperties": false }, "description": "Matching tweets on this page" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page; pass it back as `cursor`, null when there are no more results" } }, "required": [ "tweets", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.x.getTweetQuotes({\n tweetId: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/github/get-profile": { "post": { "summary": "Fetch a GitHub user's profile and pinned repositories", "tags": [ "GitHub" ], "description": "Get a GitHub user's public profile by username: name, bio, company, location, website, X handle, follower and repository counts, join date and pinned repositories. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}$", "description": "GitHub username (login) without the \"@\", e.g. \"torvalds\"." } }, "required": [ "username" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "User GraphQL node id, e.g. \"MDQ6VXNlcjEwMjQwMjU=\"." }, "databaseId": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Stable numeric user id, e.g. 1024025, or null." }, "username": { "type": "string", "description": "GitHub username (login), e.g. \"torvalds\"." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name, e.g. \"Linus Torvalds\"." }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile bio text, or null." }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Company field, or null." }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Location field, or null." }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Publicly listed email, or null when not public." }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Website URL field, or null." }, "twitterUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Linked X/Twitter handle without the \"@\", or null." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the user's avatar image." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public profile URL, e.g. \"https://github.com/torvalds\"." }, "isHireable": { "type": "boolean", "description": "Whether the user marked themselves available for hire." }, "followersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts the user follows." }, "publicRepositoriesCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of the user's public, non-fork-inclusive repositories." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp the account was created." }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp the profile was last updated." }, "pinnedRepos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Repository GraphQL node id, e.g. \"R_kgDOABCDEF\"." }, "databaseId": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Stable numeric repository id, e.g. 2325298, or null." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Repository name, e.g. \"linux\"." }, "nameWithOwner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full name including owner, e.g. \"torvalds/linux\"." }, "owner": { "type": "object", "properties": { "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Owner login (username or org name), e.g. \"torvalds\"." }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Owner GraphQL node id, e.g. \"MDQ6VXNlcjEwMjQwMjU=\"." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public profile URL, e.g. \"https://github.com/torvalds\"." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the owner's avatar image." } }, "required": [ "username", "id", "url", "avatarUrl" ], "additionalProperties": false, "description": "The user or organization that owns it." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Short repository description, or null." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public repository URL, e.g. \"https://github.com/torvalds/linux\"." }, "homepageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Project homepage URL set on the repo, or null." }, "isPrivate": { "type": "boolean", "description": "Whether the repository is private." }, "isFork": { "type": "boolean", "description": "Whether the repository is a fork." }, "isArchived": { "type": "boolean", "description": "Whether the repository is archived." }, "isTemplate": { "type": "boolean", "description": "Whether the repository is a template." }, "primaryLanguage": { "anyOf": [ { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Language name, e.g. \"TypeScript\"." }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hex color GitHub uses for the language, or null." } }, "required": [ "name", "color" ], "additionalProperties": false }, { "type": "null" } ], "description": "The most-used language in the repo, or null." }, "stargazerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of stars." }, "forkCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of forks." }, "watcherCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of watchers." }, "openIssuesCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of open issues." }, "diskUsage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Repository size in kilobytes, or null." }, "license": { "anyOf": [ { "type": "object", "properties": { "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SPDX license key, e.g. \"mit\"." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full license name, e.g. \"MIT License\"." }, "spdxId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SPDX identifier, e.g. \"MIT\", or null." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the license on choosealicense.com, or null." } }, "required": [ "key", "name", "spdxId", "url" ], "additionalProperties": false }, { "type": "null" } ], "description": "The repository's license, or null when unlicensed." }, "topics": { "type": "array", "items": { "type": "string" }, "description": "Repository topics, e.g. [\"kernel\", \"linux\"]." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp the repository was created." }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp the repository was last updated." }, "pushedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp of the last push, or null." } }, "required": [ "id", "databaseId", "name", "nameWithOwner", "owner", "description", "url", "homepageUrl", "isPrivate", "isFork", "isArchived", "isTemplate", "primaryLanguage", "stargazerCount", "forkCount", "watcherCount", "openIssuesCount", "diskUsage", "license", "topics", "createdAt", "updatedAt", "pushedAt" ], "additionalProperties": false }, "description": "Repositories the user pinned to their profile (up to 6)." } }, "required": [ "id", "databaseId", "username", "name", "bio", "company", "location", "email", "websiteUrl", "twitterUsername", "avatarUrl", "url", "isHireable", "followersCount", "followingCount", "publicRepositoriesCount", "createdAt", "updatedAt", "pinnedRepos" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.github.getProfile({\n username: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/github/get-contributions": { "post": { "summary": "Fetch a GitHub user's contribution calendar and totals", "tags": [ "GitHub" ], "description": "Get a GitHub user's contribution graph for a date range of up to one year: the contribution count for each day plus totals for commits, issues, pull requests, reviews and new repositories. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}$", "description": "GitHub username (login) without the \"@\", e.g. \"torvalds\"." }, "from": { "description": "ISO-8601 start of the contribution window (inclusive), e.g. \"2025-01-01T00:00:00Z\". Defaults to one year ago. Must be within one year of `to`.", "type": "string" }, "to": { "description": "ISO-8601 end of the contribution window (inclusive), e.g. \"2025-12-31T00:00:00Z\". Defaults to now.", "type": "string" } }, "required": [ "username" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "username": { "type": "string", "description": "GitHub login the contributions belong to." }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 start of the contribution window (inclusive)." }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 end of the contribution window (inclusive)." }, "totalContributions": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total contributions in the calendar window." }, "totalCommitContributions": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Commits contributed in the window." }, "totalIssueContributions": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Issues opened in the window." }, "totalPullRequestContributions": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Pull requests opened in the window." }, "totalPullRequestReviewContributions": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Pull request reviews in the window." }, "totalRepositoryContributions": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "New repositories created in the window." }, "restrictedContributionsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Private/anonymized contributions not otherwise counted." }, "days": { "type": "array", "items": { "type": "object", "properties": { "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Calendar day, e.g. \"2026-07-25\"." }, "count": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of contributions on that day." }, "weekday": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Day of week, 0 (Sunday) through 6 (Saturday)." }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hex color GitHub renders for that day, e.g. \"#216e39\"." } }, "required": [ "date", "count", "weekday", "color" ], "additionalProperties": false }, "description": "Flattened per-day contribution calendar." } }, "required": [ "username", "from", "to", "totalContributions", "totalCommitContributions", "totalIssueContributions", "totalPullRequestContributions", "totalPullRequestReviewContributions", "totalRepositoryContributions", "restrictedContributionsCount", "days" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.github.getContributions({\n username: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/github/list-repositories": { "post": { "summary": "List a GitHub user's public repositories", "tags": [ "GitHub" ], "description": "List a GitHub user's public repositories, sorted by last push or another order. Each repository includes its description, primary language, star, fork and watcher counts and whether it is a fork or archived. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}$", "description": "GitHub username (login) without the \"@\", e.g. \"torvalds\"." }, "count": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 }, "after": { "description": "Pagination cursor (the `after` value returned by a previous page). Omit for the first page.", "type": "string" }, "order": { "default": "pushed", "description": "Sort order for the repositories. Defaults to \"pushed\".", "type": "string", "enum": [ "pushed", "updated", "created", "name", "stars" ] } }, "required": [ "username" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "username": { "type": "string", "description": "GitHub login the repositories belong to." }, "repositories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Repository GraphQL node id, e.g. \"R_kgDOABCDEF\"." }, "databaseId": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Stable numeric repository id, e.g. 2325298, or null." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Repository name, e.g. \"linux\"." }, "nameWithOwner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full name including owner, e.g. \"torvalds/linux\"." }, "owner": { "type": "object", "properties": { "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Owner login (username or org name), e.g. \"torvalds\"." }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Owner GraphQL node id, e.g. \"MDQ6VXNlcjEwMjQwMjU=\"." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public profile URL, e.g. \"https://github.com/torvalds\"." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the owner's avatar image." } }, "required": [ "username", "id", "url", "avatarUrl" ], "additionalProperties": false, "description": "The user or organization that owns it." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Short repository description, or null." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public repository URL, e.g. \"https://github.com/torvalds/linux\"." }, "homepageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Project homepage URL set on the repo, or null." }, "isPrivate": { "type": "boolean", "description": "Whether the repository is private." }, "isFork": { "type": "boolean", "description": "Whether the repository is a fork." }, "isArchived": { "type": "boolean", "description": "Whether the repository is archived." }, "isTemplate": { "type": "boolean", "description": "Whether the repository is a template." }, "primaryLanguage": { "anyOf": [ { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Language name, e.g. \"TypeScript\"." }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hex color GitHub uses for the language, or null." } }, "required": [ "name", "color" ], "additionalProperties": false }, { "type": "null" } ], "description": "The most-used language in the repo, or null." }, "stargazerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of stars." }, "forkCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of forks." }, "watcherCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of watchers." }, "openIssuesCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of open issues." }, "diskUsage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Repository size in kilobytes, or null." }, "license": { "anyOf": [ { "type": "object", "properties": { "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SPDX license key, e.g. \"mit\"." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full license name, e.g. \"MIT License\"." }, "spdxId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SPDX identifier, e.g. \"MIT\", or null." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the license on choosealicense.com, or null." } }, "required": [ "key", "name", "spdxId", "url" ], "additionalProperties": false }, { "type": "null" } ], "description": "The repository's license, or null when unlicensed." }, "topics": { "type": "array", "items": { "type": "string" }, "description": "Repository topics, e.g. [\"kernel\", \"linux\"]." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp the repository was created." }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp the repository was last updated." }, "pushedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp of the last push, or null." } }, "required": [ "id", "databaseId", "name", "nameWithOwner", "owner", "description", "url", "homepageUrl", "isPrivate", "isFork", "isArchived", "isTemplate", "primaryLanguage", "stargazerCount", "forkCount", "watcherCount", "openIssuesCount", "diskUsage", "license", "topics", "createdAt", "updatedAt", "pushedAt" ], "additionalProperties": false }, "description": "The user's repositories for this page." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (GitHub `endCursor`), or null when there are no more results." } }, "required": [ "username", "repositories", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.github.listRepositories({\n username: \"string\",\n count: 10,\n order: \"pushed\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/github/list-starred": { "post": { "summary": "List the repositories a GitHub user has starred", "tags": [ "GitHub" ], "description": "List the repositories a GitHub user has starred, with each repository's owner, description, primary language and star and fork counts. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}$", "description": "GitHub username (login) without the \"@\", e.g. \"torvalds\"." }, "count": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 }, "after": { "description": "Pagination cursor (the `after` value returned by a previous page). Omit for the first page.", "type": "string" } }, "required": [ "username" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "username": { "type": "string", "description": "GitHub login whose stars these are." }, "repositories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Repository GraphQL node id, e.g. \"R_kgDOABCDEF\"." }, "databaseId": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Stable numeric repository id, e.g. 2325298, or null." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Repository name, e.g. \"linux\"." }, "nameWithOwner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full name including owner, e.g. \"torvalds/linux\"." }, "owner": { "type": "object", "properties": { "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Owner login (username or org name), e.g. \"torvalds\"." }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Owner GraphQL node id, e.g. \"MDQ6VXNlcjEwMjQwMjU=\"." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public profile URL, e.g. \"https://github.com/torvalds\"." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the owner's avatar image." } }, "required": [ "username", "id", "url", "avatarUrl" ], "additionalProperties": false, "description": "The user or organization that owns it." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Short repository description, or null." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public repository URL, e.g. \"https://github.com/torvalds/linux\"." }, "homepageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Project homepage URL set on the repo, or null." }, "isPrivate": { "type": "boolean", "description": "Whether the repository is private." }, "isFork": { "type": "boolean", "description": "Whether the repository is a fork." }, "isArchived": { "type": "boolean", "description": "Whether the repository is archived." }, "isTemplate": { "type": "boolean", "description": "Whether the repository is a template." }, "primaryLanguage": { "anyOf": [ { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Language name, e.g. \"TypeScript\"." }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hex color GitHub uses for the language, or null." } }, "required": [ "name", "color" ], "additionalProperties": false }, { "type": "null" } ], "description": "The most-used language in the repo, or null." }, "stargazerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of stars." }, "forkCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of forks." }, "watcherCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of watchers." }, "openIssuesCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of open issues." }, "diskUsage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Repository size in kilobytes, or null." }, "license": { "anyOf": [ { "type": "object", "properties": { "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SPDX license key, e.g. \"mit\"." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full license name, e.g. \"MIT License\"." }, "spdxId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SPDX identifier, e.g. \"MIT\", or null." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the license on choosealicense.com, or null." } }, "required": [ "key", "name", "spdxId", "url" ], "additionalProperties": false }, { "type": "null" } ], "description": "The repository's license, or null when unlicensed." }, "topics": { "type": "array", "items": { "type": "string" }, "description": "Repository topics, e.g. [\"kernel\", \"linux\"]." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp the repository was created." }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp the repository was last updated." }, "pushedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp of the last push, or null." } }, "required": [ "id", "databaseId", "name", "nameWithOwner", "owner", "description", "url", "homepageUrl", "isPrivate", "isFork", "isArchived", "isTemplate", "primaryLanguage", "stargazerCount", "forkCount", "watcherCount", "openIssuesCount", "diskUsage", "license", "topics", "createdAt", "updatedAt", "pushedAt" ], "additionalProperties": false }, "description": "Repositories the user has starred, for this page." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (GitHub `endCursor`), or null when there are no more results." } }, "required": [ "username", "repositories", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.github.listStarred({\n username: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/github/list-projects": { "post": { "summary": "List a GitHub user's public projects", "tags": [ "GitHub" ], "description": "List a GitHub user's public project boards, with each project's title, description, link, open or closed state and creation and update dates. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}$", "description": "GitHub username (login) without the \"@\", e.g. \"torvalds\"." }, "count": { "default": 10, "description": "Number of results to return (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 }, "after": { "description": "Pagination cursor (the `after` value returned by a previous page). Omit for the first page.", "type": "string" } }, "required": [ "username" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "username": { "type": "string", "description": "GitHub login the projects belong to." }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Project GraphQL node id." }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Project number in the owner's project list, e.g. 3." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Project title." }, "shortDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Short project description, or null." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public project URL." }, "closed": { "type": "boolean", "description": "Whether the project is closed." }, "public": { "type": "boolean", "description": "Whether the project is public." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp the project was created." }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp the project was last updated." } }, "required": [ "id", "number", "title", "shortDescription", "url", "closed", "public", "createdAt", "updatedAt" ], "additionalProperties": false }, "description": "The user's projects for this page." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (GitHub `endCursor`), or null when there are no more results." } }, "required": [ "username", "projects", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.github.listProjects({\n username: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/github/search-repositories": { "post": { "summary": "Search public GitHub repositories", "tags": [ "GitHub" ], "description": "Search public GitHub repositories by keyword and filter by owner, language, stars, forks, topics, license or creation and last-push date. Each result includes the description, primary language and star and fork counts. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "description": "Free-text search terms, matched against the default fields for this search type, e.g. \"web framework\".", "type": "string", "maxLength": 256 }, "owners": { "description": "Limit to these owners (users or orgs). Maps to `user:`.", "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}$" } }, "repos": { "description": "Limit to these \"owner/name\" repositories. Maps to `repo:`.", "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}\\/[\\w.-]+$" } }, "language": { "description": "Primary language, e.g. \"TypeScript\". Maps to `language:`.", "type": "string" }, "stars": { "description": "Filter by star count. Provide any of gt / gte / lt / lte; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly greater than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "gte": { "description": "Greater than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lt": { "description": "Strictly less than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lte": { "description": "Less than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "forks": { "description": "Filter by fork count. Provide any of gt / gte / lt / lte; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly greater than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "gte": { "description": "Greater than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lt": { "description": "Strictly less than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lte": { "description": "Less than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "size": { "description": "Filter by repository size in KB. Provide any of gt / gte / lt / lte; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly greater than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "gte": { "description": "Greater than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lt": { "description": "Strictly less than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lte": { "description": "Less than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "created": { "description": "Filter by creation date. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "pushed": { "description": "Filter by date of last push. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "topics": { "description": "Require each of these topics. Maps to `topic:`.", "type": "array", "items": { "type": "string" } }, "license": { "description": "SPDX license key, e.g. \"mit\". Maps to `license:`.", "type": "string" }, "archived": { "description": "Filter by archived state. Maps to `archived:`.", "type": "boolean" }, "visibility": { "description": "Repository visibility. Maps to `is:public` / `is:private`.", "type": "string", "enum": [ "public", "private" ] }, "fork": { "default": "exclude", "description": "Whether to include forks: \"exclude\" (default), \"include\" (`fork:true`), or \"only\" (`fork:only`).", "type": "string", "enum": [ "exclude", "include", "only" ] }, "sort": { "default": "best-match", "description": "Sort field. Defaults to relevance (\"best-match\").", "type": "string", "enum": [ "best-match", "stars", "forks", "updated", "help-wanted-issues" ] }, "order": { "default": "desc", "description": "Sort direction. Defaults to \"desc\".", "type": "string", "enum": [ "desc", "asc" ] }, "count": { "default": 10, "description": "Number of results per page (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 }, "after": { "description": "Pagination cursor (the `after` value returned by a previous page). Omit for the first page.", "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "query": { "type": "string", "description": "The compiled GitHub search query string that was run." }, "totalCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total matches GitHub reports (approximate, and capped at 1000 results)." }, "repositories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Repository GraphQL node id, e.g. \"R_kgDOABCDEF\"." }, "databaseId": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Stable numeric repository id, e.g. 2325298, or null." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Repository name, e.g. \"linux\"." }, "nameWithOwner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full name including owner, e.g. \"torvalds/linux\"." }, "owner": { "type": "object", "properties": { "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Owner login (username or org name), e.g. \"torvalds\"." }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Owner GraphQL node id, e.g. \"MDQ6VXNlcjEwMjQwMjU=\"." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public profile URL, e.g. \"https://github.com/torvalds\"." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the owner's avatar image." } }, "required": [ "username", "id", "url", "avatarUrl" ], "additionalProperties": false, "description": "The user or organization that owns it." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Short repository description, or null." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public repository URL, e.g. \"https://github.com/torvalds/linux\"." }, "homepageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Project homepage URL set on the repo, or null." }, "isPrivate": { "type": "boolean", "description": "Whether the repository is private." }, "isFork": { "type": "boolean", "description": "Whether the repository is a fork." }, "isArchived": { "type": "boolean", "description": "Whether the repository is archived." }, "isTemplate": { "type": "boolean", "description": "Whether the repository is a template." }, "primaryLanguage": { "anyOf": [ { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Language name, e.g. \"TypeScript\"." }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hex color GitHub uses for the language, or null." } }, "required": [ "name", "color" ], "additionalProperties": false }, { "type": "null" } ], "description": "The most-used language in the repo, or null." }, "stargazerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of stars." }, "forkCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of forks." }, "watcherCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of watchers." }, "openIssuesCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of open issues." }, "diskUsage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Repository size in kilobytes, or null." }, "license": { "anyOf": [ { "type": "object", "properties": { "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SPDX license key, e.g. \"mit\"." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full license name, e.g. \"MIT License\"." }, "spdxId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SPDX identifier, e.g. \"MIT\", or null." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the license on choosealicense.com, or null." } }, "required": [ "key", "name", "spdxId", "url" ], "additionalProperties": false }, { "type": "null" } ], "description": "The repository's license, or null when unlicensed." }, "topics": { "type": "array", "items": { "type": "string" }, "description": "Repository topics, e.g. [\"kernel\", \"linux\"]." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp the repository was created." }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp the repository was last updated." }, "pushedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp of the last push, or null." } }, "required": [ "id", "databaseId", "name", "nameWithOwner", "owner", "description", "url", "homepageUrl", "isPrivate", "isFork", "isArchived", "isTemplate", "primaryLanguage", "stargazerCount", "forkCount", "watcherCount", "openIssuesCount", "diskUsage", "license", "topics", "createdAt", "updatedAt", "pushedAt" ], "additionalProperties": false }, "description": "Repositories matching this page." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (GitHub `endCursor`), or null when there are no more results." } }, "required": [ "query", "totalCount", "repositories", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.github.searchRepositories({\n fork: \"exclude\",\n sort: \"best-match\",\n order: \"desc\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/github/search-code": { "post": { "summary": "Search code across public GitHub repositories", "tags": [ "GitHub" ], "description": "Search source code across public GitHub repositories, filtered by language, file extension, file name, path, owner or repository. Each result gives the file name, path, link and the repository it belongs to. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "description": "Free-text search terms, matched against the default fields for this search type, e.g. \"web framework\".", "type": "string", "maxLength": 256 }, "owners": { "description": "Limit to these owners (users or orgs). Maps to `user:`.", "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}$" } }, "repos": { "description": "Limit to these \"owner/name\" repositories. Maps to `repo:`.", "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}\\/[\\w.-]+$" } }, "language": { "description": "Programming language, e.g. \"Go\". Maps to `language:`.", "type": "string" }, "extension": { "description": "File extension without the dot, e.g. \"ts\". Maps to `extension:`.", "type": "string" }, "filename": { "description": "Exact file name, e.g. \"package.json\". Maps to `filename:`.", "type": "string" }, "path": { "description": "Path prefix within the repo, e.g. \"src/app\". Maps to `path:`.", "type": "string" }, "fork": { "default": "exclude", "description": "Whether to include forks. Defaults to excluding them.", "type": "string", "enum": [ "exclude", "include" ] }, "sort": { "default": "best-match", "description": "Sort field. Defaults to relevance (\"best-match\").", "type": "string", "enum": [ "best-match", "indexed" ] }, "order": { "default": "desc", "description": "Sort direction. Defaults to \"desc\".", "type": "string", "enum": [ "desc", "asc" ] }, "count": { "default": 10, "description": "Number of results per page (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 }, "page": { "default": 1, "description": "1-based page number. Defaults to 1. Only the first 1,000 results of a search can be paged through.", "type": "integer", "minimum": 1, "maximum": 100 } } } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "query": { "type": "string", "description": "The compiled GitHub search query string that was run." }, "totalCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total matches GitHub reports (approximate, and capped at 1000 results)." }, "results": { "type": "array", "items": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File name, e.g. \"server.ts\"." }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File path within the repository, e.g. \"src/server.ts\"." }, "sha": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Git blob SHA of the matched file." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "GitHub API URL of the file." }, "htmlUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public GitHub URL of the file on its default branch." }, "repository": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Stable numeric repository id, e.g. 2325298." }, "nodeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Repository GraphQL node id." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Repository name, e.g. \"linux\"." }, "fullName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full name including owner, e.g. \"torvalds/linux\"." }, "ownerLogin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Owner login (username or org name)." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public repository URL." }, "isPrivate": { "type": "boolean", "description": "Whether the repository is private." } }, "required": [ "id", "nodeId", "name", "fullName", "ownerLogin", "url", "isPrivate" ], "additionalProperties": false, "description": "The repository the file lives in." } }, "required": [ "name", "path", "sha", "url", "htmlUrl", "repository" ], "additionalProperties": false }, "description": "Code files matching this page." }, "nextPage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The next 1-based page number, or null when this is the last page." } }, "required": [ "query", "totalCount", "results", "nextPage" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.github.searchCode({\n fork: \"exclude\",\n sort: \"best-match\",\n order: \"desc\",\n count: 10,\n page: 1,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/github/search-commits": { "post": { "summary": "Search commits across public GitHub repositories", "tags": [ "GitHub" ], "description": "Search commits across public GitHub repositories by message, author, committer, date or hash. Each result includes the commit message, SHA, author, committer, link and repository. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "description": "Free-text search terms, matched against the default fields for this search type, e.g. \"web framework\".", "type": "string", "maxLength": 256 }, "owners": { "description": "Limit to these owners (users or orgs). Maps to `user:`.", "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}$" } }, "repos": { "description": "Limit to these \"owner/name\" repositories. Maps to `repo:`.", "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}\\/[\\w.-]+$" } }, "author": { "description": "Commits authored by this GitHub user. Maps to `author:`.", "type": "string" }, "committer": { "description": "Commits committed by this GitHub user. Maps to `committer:`.", "type": "string" }, "authoredDate": { "description": "Filter by author date. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "committedDate": { "description": "Filter by commit date. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "hash": { "description": "Commits with this SHA (or prefix). Maps to `hash:`.", "type": "string" }, "merge": { "description": "Only merge commits (true) or exclude them (false). Maps to `merge:`.", "type": "boolean" }, "sort": { "default": "best-match", "description": "Sort field. Defaults to relevance (\"best-match\").", "type": "string", "enum": [ "best-match", "author-date", "committer-date" ] }, "order": { "default": "desc", "description": "Sort direction. Defaults to \"desc\".", "type": "string", "enum": [ "desc", "asc" ] }, "count": { "default": 10, "description": "Number of results per page (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 }, "page": { "default": 1, "description": "1-based page number. Defaults to 1. Only the first 1,000 results of a search can be paged through.", "type": "integer", "minimum": 1, "maximum": 100 } } } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "query": { "type": "string", "description": "The compiled GitHub search query string that was run." }, "totalCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total matches GitHub reports (approximate, and capped at 1000 results)." }, "commits": { "type": "array", "items": { "type": "object", "properties": { "sha": { "type": "string", "description": "Full commit SHA." }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Commit message." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public GitHub URL of the commit." }, "apiUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "GitHub API URL of the commit." }, "author": { "anyOf": [ { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Git name, e.g. \"Linus Torvalds\"." }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Git email address." }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp." } }, "required": [ "name", "email", "date" ], "additionalProperties": false }, { "type": "null" } ], "description": "Git author of the commit." }, "authorLogin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Linked GitHub login of the author, or null." }, "committer": { "anyOf": [ { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Git name, e.g. \"Linus Torvalds\"." }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Git email address." }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp." } }, "required": [ "name", "email", "date" ], "additionalProperties": false }, { "type": "null" } ], "description": "Git committer." }, "committerLogin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Linked GitHub login of the committer, or null." }, "commentCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of comments." }, "repository": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Stable numeric repository id, e.g. 2325298." }, "nodeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Repository GraphQL node id." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Repository name, e.g. \"linux\"." }, "fullName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full name including owner, e.g. \"torvalds/linux\"." }, "ownerLogin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Owner login (username or org name)." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public repository URL." }, "isPrivate": { "type": "boolean", "description": "Whether the repository is private." } }, "required": [ "id", "nodeId", "name", "fullName", "ownerLogin", "url", "isPrivate" ], "additionalProperties": false, "description": "The repository the commit is in." } }, "required": [ "sha", "message", "url", "apiUrl", "author", "authorLogin", "committer", "committerLogin", "commentCount", "repository" ], "additionalProperties": false }, "description": "Commits matching this page." }, "nextPage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The next 1-based page number, or null when this is the last page." } }, "required": [ "query", "totalCount", "commits", "nextPage" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.github.searchCommits({\n sort: \"best-match\",\n order: \"desc\",\n count: 10,\n page: 1,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/github/search-issues": { "post": { "summary": "Search GitHub issues", "tags": [ "GitHub" ], "description": "Search GitHub issues by keyword and filter by repository, state, author, assignee, labels, comment count or date. Each result includes the title, state, author, labels, comment count and dates. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "description": "Free-text search terms, matched against the default fields for this search type, e.g. \"web framework\".", "type": "string", "maxLength": 256 }, "owners": { "description": "Limit to these owners (users or orgs). Maps to `user:`.", "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}$" } }, "repos": { "description": "Limit to these \"owner/name\" repositories. Maps to `repo:`.", "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}\\/[\\w.-]+$" } }, "language": { "description": "Language of the containing repo. Maps to `language:`.", "type": "string" }, "state": { "description": "Issue/PR state. Maps to `state:`.", "type": "string", "enum": [ "open", "closed" ] }, "author": { "description": "Opened by this user. Maps to `author:`.", "type": "string" }, "assignee": { "description": "Assigned to this user. Maps to `assignee:`.", "type": "string" }, "mentions": { "description": "Mentioning this user. Maps to `mentions:`.", "type": "string" }, "labels": { "description": "Require each of these labels. Maps to `label:`.", "type": "array", "items": { "type": "string" } }, "comments": { "description": "Filter by comment count. Provide any of gt / gte / lt / lte; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly greater than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "gte": { "description": "Greater than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lt": { "description": "Strictly less than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lte": { "description": "Less than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "created": { "description": "Filter by creation date. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "updated": { "description": "Filter by last update date. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "closed": { "description": "Filter by closed date. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "order": { "default": "desc", "description": "Sort direction. Defaults to \"desc\".", "type": "string", "enum": [ "desc", "asc" ] }, "count": { "default": 10, "description": "Number of results per page (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 }, "after": { "description": "Pagination cursor (the `after` value returned by a previous page). Omit for the first page.", "type": "string" }, "reason": { "description": "State reason for closed issues. Maps to `reason:`.", "type": "string", "enum": [ "completed", "not-planned", "reopened" ] }, "sort": { "default": "best-match", "description": "Sort field. Defaults to relevance (\"best-match\").", "type": "string", "enum": [ "best-match", "created", "updated", "comments" ] } } } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "query": { "type": "string", "description": "The compiled GitHub search query string that was run." }, "totalCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total matches GitHub reports (approximate, and capped at 1000 results)." }, "issues": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Issue/PR GraphQL node id." }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Issue/PR number within its repo." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Issue/PR title." }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "State: \"OPEN\", \"CLOSED\", or \"MERGED\" (PRs)." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public GitHub URL." }, "isPullRequest": { "type": "boolean", "description": "Whether this result is a pull request (vs. an issue)." }, "isDraft": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the PR is a draft (null for issues)." }, "merged": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the PR is merged (null for issues)." }, "authorLogin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Login of the opener, or null." }, "repository": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Containing repo \"owner/name\", e.g. \"facebook/react\"." }, "repositoryUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the containing repo." }, "commentsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of comments." }, "labels": { "type": "array", "items": { "type": "string" }, "description": "Label names on the issue/PR." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 creation timestamp." }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 last-update timestamp." }, "closedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 closed timestamp, or null if open." } }, "required": [ "id", "number", "title", "state", "url", "isPullRequest", "isDraft", "merged", "authorLogin", "repository", "repositoryUrl", "commentsCount", "labels", "createdAt", "updatedAt", "closedAt" ], "additionalProperties": false }, "description": "Issues or pull requests matching this page." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (GitHub `endCursor`), or null when there are no more results." } }, "required": [ "query", "totalCount", "issues", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.github.searchIssues({\n order: \"desc\",\n count: 10,\n sort: \"best-match\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/github/search-pull-requests": { "post": { "summary": "Search GitHub pull requests", "tags": [ "GitHub" ], "description": "Search GitHub pull requests by keyword and filter by repository, state, author, labels, review status, draft state or merge date. Each result includes the title, state, author, merge status, labels and dates. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "description": "Free-text search terms, matched against the default fields for this search type, e.g. \"web framework\".", "type": "string", "maxLength": 256 }, "owners": { "description": "Limit to these owners (users or orgs). Maps to `user:`.", "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}$" } }, "repos": { "description": "Limit to these \"owner/name\" repositories. Maps to `repo:`.", "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}\\/[\\w.-]+$" } }, "language": { "description": "Language of the containing repo. Maps to `language:`.", "type": "string" }, "state": { "description": "Issue/PR state. Maps to `state:`.", "type": "string", "enum": [ "open", "closed" ] }, "author": { "description": "Opened by this user. Maps to `author:`.", "type": "string" }, "assignee": { "description": "Assigned to this user. Maps to `assignee:`.", "type": "string" }, "mentions": { "description": "Mentioning this user. Maps to `mentions:`.", "type": "string" }, "labels": { "description": "Require each of these labels. Maps to `label:`.", "type": "array", "items": { "type": "string" } }, "comments": { "description": "Filter by comment count. Provide any of gt / gte / lt / lte; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly greater than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "gte": { "description": "Greater than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lt": { "description": "Strictly less than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lte": { "description": "Less than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "created": { "description": "Filter by creation date. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "updated": { "description": "Filter by last update date. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "closed": { "description": "Filter by closed date. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "order": { "default": "desc", "description": "Sort direction. Defaults to \"desc\".", "type": "string", "enum": [ "desc", "asc" ] }, "count": { "default": 10, "description": "Number of results per page (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 }, "after": { "description": "Pagination cursor (the `after` value returned by a previous page). Omit for the first page.", "type": "string" }, "draft": { "description": "Filter by draft state. Maps to `draft:`.", "type": "boolean" }, "merged": { "description": "Filter by merge date (only merged PRs). Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "review": { "description": "Review status. Maps to `review:`.", "type": "string", "enum": [ "none", "required", "approved", "changes-requested" ] }, "sort": { "default": "best-match", "description": "Sort field. Defaults to relevance (\"best-match\").", "type": "string", "enum": [ "best-match", "created", "updated", "comments" ] } } } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "query": { "type": "string", "description": "The compiled GitHub search query string that was run." }, "totalCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total matches GitHub reports (approximate, and capped at 1000 results)." }, "issues": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Issue/PR GraphQL node id." }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Issue/PR number within its repo." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Issue/PR title." }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "State: \"OPEN\", \"CLOSED\", or \"MERGED\" (PRs)." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public GitHub URL." }, "isPullRequest": { "type": "boolean", "description": "Whether this result is a pull request (vs. an issue)." }, "isDraft": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the PR is a draft (null for issues)." }, "merged": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the PR is merged (null for issues)." }, "authorLogin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Login of the opener, or null." }, "repository": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Containing repo \"owner/name\", e.g. \"facebook/react\"." }, "repositoryUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the containing repo." }, "commentsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of comments." }, "labels": { "type": "array", "items": { "type": "string" }, "description": "Label names on the issue/PR." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 creation timestamp." }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 last-update timestamp." }, "closedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 closed timestamp, or null if open." } }, "required": [ "id", "number", "title", "state", "url", "isPullRequest", "isDraft", "merged", "authorLogin", "repository", "repositoryUrl", "commentsCount", "labels", "createdAt", "updatedAt", "closedAt" ], "additionalProperties": false }, "description": "Issues or pull requests matching this page." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (GitHub `endCursor`), or null when there are no more results." } }, "required": [ "query", "totalCount", "issues", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.github.searchPullRequests({\n order: \"desc\",\n count: 10,\n sort: \"best-match\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/github/search-discussions": { "post": { "summary": "Search GitHub discussions", "tags": [ "GitHub" ], "description": "Search GitHub Discussions by keyword and filter by repository, author, comment count, date or whether they are answered. Each result includes the title, category, author, comment count and answered status. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "description": "Free-text search terms, matched against the default fields for this search type, e.g. \"web framework\".", "type": "string", "maxLength": 256 }, "owners": { "description": "Limit to these owners (users or orgs). Maps to `user:`.", "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}$" } }, "repos": { "description": "Limit to these \"owner/name\" repositories. Maps to `repo:`.", "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z\\d][A-Za-z\\d_-]{0,38}\\/[\\w.-]+$" } }, "author": { "description": "Opened by this user. Maps to `author:`.", "type": "string" }, "comments": { "description": "Filter by comment count. Provide any of gt / gte / lt / lte; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly greater than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "gte": { "description": "Greater than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lt": { "description": "Strictly less than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lte": { "description": "Less than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "created": { "description": "Filter by creation date. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "updated": { "description": "Filter by last update date. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "answered": { "description": "Whether the discussion is answered. Maps to `is:answered`.", "type": "boolean" }, "order": { "default": "desc", "description": "Sort direction. Defaults to \"desc\".", "type": "string", "enum": [ "desc", "asc" ] }, "count": { "default": 10, "description": "Number of results per page (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 }, "after": { "description": "Pagination cursor (the `after` value returned by a previous page). Omit for the first page.", "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "query": { "type": "string", "description": "The compiled GitHub search query string that was run." }, "totalCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total matches GitHub reports (approximate, and capped at 1000 results)." }, "discussions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Discussion GraphQL node id." }, "number": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Discussion number within its repo." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Discussion title." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public GitHub URL." }, "authorLogin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Login of the opener, or null." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Discussion category name." }, "repository": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Containing repo \"owner/name\"." }, "repositoryUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the containing repo." }, "commentsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of comments." }, "isAnswered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the discussion is marked answered." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 creation timestamp." }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 last-update timestamp." } }, "required": [ "id", "number", "title", "url", "authorLogin", "category", "repository", "repositoryUrl", "commentsCount", "isAnswered", "createdAt", "updatedAt" ], "additionalProperties": false }, "description": "Discussions matching this page." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (GitHub `endCursor`), or null when there are no more results." } }, "required": [ "query", "totalCount", "discussions", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.github.searchDiscussions({\n order: \"desc\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/github/search-users": { "post": { "summary": "Search GitHub users and organizations", "tags": [ "GitHub" ], "description": "Search GitHub users and organizations by keyword, name, location, language, follower count, repository count or join date. Each result includes the username, name, bio, location and follower and repository counts. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "description": "Free-text search terms, matched against the default fields for this search type, e.g. \"web framework\".", "type": "string", "maxLength": 256 }, "type": { "description": "Restrict to users or organizations. Maps to `type:`.", "type": "string", "enum": [ "user", "org" ] }, "fullName": { "description": "Match a display name, e.g. \"Grace Hopper\". Maps to `fullname:`.", "type": "string" }, "location": { "description": "Profile location, e.g. \"San Francisco\". Maps to `location:`.", "type": "string" }, "language": { "description": "Users who code in this language. Maps to `language:`.", "type": "string" }, "followers": { "description": "Filter by follower count. Provide any of gt / gte / lt / lte; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly greater than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "gte": { "description": "Greater than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lt": { "description": "Strictly less than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lte": { "description": "Less than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "repos": { "description": "Filter by public repository count. Provide any of gt / gte / lt / lte; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly greater than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "gte": { "description": "Greater than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lt": { "description": "Strictly less than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lte": { "description": "Less than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "created": { "description": "Filter by account creation date. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "sort": { "default": "best-match", "description": "Sort field. Defaults to relevance (\"best-match\").", "type": "string", "enum": [ "best-match", "followers", "repositories", "joined" ] }, "order": { "default": "desc", "description": "Sort direction. Defaults to \"desc\".", "type": "string", "enum": [ "desc", "asc" ] }, "count": { "default": 10, "description": "Number of results per page (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 }, "after": { "description": "Pagination cursor (the `after` value returned by a previous page). Omit for the first page.", "type": "string" } } } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "query": { "type": "string", "description": "The compiled GitHub search query string that was run." }, "totalCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total matches GitHub reports (approximate, and capped at 1000 results)." }, "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "User/Org GraphQL node id." }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "\"User\" or \"Organization\"." }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Login (username or org name)." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name, or null." }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile bio / description, or null." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the avatar image." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public profile URL." }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile location, or null." }, "followersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Follower count (null for organizations)." }, "repositoriesCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Public repository count." } }, "required": [ "id", "type", "username", "name", "bio", "avatarUrl", "url", "location", "followersCount", "repositoriesCount" ], "additionalProperties": false }, "description": "Users and organizations matching this page." }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor for the next page (GitHub `endCursor`), or null when there are no more results." } }, "required": [ "query", "totalCount", "users", "after" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.github.searchUsers({\n sort: \"best-match\",\n order: \"desc\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/github/search-topics": { "post": { "summary": "Search GitHub topics", "tags": [ "GitHub" ], "description": "Search GitHub topics by keyword, optionally limited to featured or curated topics. Each result includes the topic name, display name, description and who created it. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "description": "Free-text search terms, matched against the default fields for this search type, e.g. \"web framework\".", "type": "string", "maxLength": 256 }, "featured": { "description": "Only featured topics. Maps to `is:featured`.", "type": "boolean" }, "curated": { "description": "Only curated topics. Maps to `is:curated`.", "type": "boolean" }, "repositories": { "description": "Filter by number of repositories using the topic. Provide any of gt / gte / lt / lte; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly greater than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "gte": { "description": "Greater than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lt": { "description": "Strictly less than this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lte": { "description": "Less than or equal to this value.", "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "created": { "description": "Filter by topic creation date. Provide any of gt / gte / lt / lte as YYYY-MM-DD dates; combine a lower and upper bound for a range.", "type": "object", "properties": { "gt": { "description": "Strictly after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "gte": { "description": "On or after this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lt": { "description": "Strictly before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "lte": { "description": "On or before this date (YYYY-MM-DD).", "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } } }, "count": { "default": 10, "description": "Number of results per page (1–10). Defaults to 10.", "type": "integer", "minimum": 1, "maximum": 10 }, "page": { "default": 1, "description": "1-based page number. Defaults to 1. Only the first 1,000 results of a search can be paged through.", "type": "integer", "minimum": 1, "maximum": 100 } } } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "query": { "type": "string", "description": "The compiled GitHub search query string that was run." }, "totalCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total matches GitHub reports (approximate, and capped at 1000 results)." }, "topics": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Topic name (slug), e.g. \"machine-learning\"." }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Human-friendly display name, or null." }, "shortDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "One-line description." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Longer description, or null." }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Who created the topic, or null." }, "featured": { "type": "boolean", "description": "Whether GitHub features this topic." }, "curated": { "type": "boolean", "description": "Whether the topic is curated." }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Search relevance score." } }, "required": [ "name", "displayName", "shortDescription", "description", "createdBy", "featured", "curated", "score" ], "additionalProperties": false }, "description": "Topics matching this page." }, "nextPage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The next 1-based page number, or null when this is the last page." } }, "required": [ "query", "totalCount", "topics", "nextPage" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.github.searchTopics({\n count: 10,\n page: 1,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/instagram/user": { "post": { "summary": "Get user profile by username", "tags": [ "Instagram" ], "description": "Get a public Instagram profile by username: full name, bio, bio links, profile picture, follower, following and post counts, and whether the account is private, verified or a business. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Instagram username, e.g. instagram" } }, "required": [ "username" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "biography": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio_links": { "default": [], "type": "array", "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "link_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url" ], "additionalProperties": false } }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followers": { "default": 0, "type": "number" }, "following": { "default": 0, "type": "number" }, "posts_count": { "default": 0, "type": "number" }, "is_private": { "default": false, "type": "boolean" }, "is_verified": { "default": false, "type": "boolean" }, "is_business_account": { "default": false, "type": "boolean" }, "is_professional_account": { "default": false, "type": "boolean" }, "category_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "username", "bio_links", "followers", "following", "posts_count", "is_private", "is_verified", "is_business_account", "is_professional_account" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.instagram.getUser({\n username: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/instagram/user-posts": { "post": { "summary": "Get paginated user posts", "tags": [ "Instagram" ], "description": "List the posts on an Instagram profile. Each post includes the caption, image or video link, like and comment counts, timestamp and, for videos, the view count. Page through older posts with the `after` cursor. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Instagram username, e.g. instagram" }, "count": { "default": 10, "description": "Page size requested from Instagram (1–10). Defaults to 10. Instagram determines the number of results returned.", "type": "integer", "minimum": 1, "maximum": 10 }, "after": { "description": "Instagram cursor from the previous response’s end_cursor", "type": "string" } }, "required": [ "username" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "has_next_page": { "type": "boolean" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "shortcode": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "Image", "Video", "Carousel" ] }, "display_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "likes": { "default": 0, "type": "number" }, "comments": { "default": 0, "type": "number" }, "timestamp": { "type": "number" }, "is_video": { "default": false, "type": "boolean" }, "video_view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "shortcode", "url", "type", "likes", "comments", "timestamp", "is_video" ], "additionalProperties": false } } }, "required": [ "has_next_page", "posts" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.instagram.getUserPosts({\n username: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/instagram/followers": { "post": { "summary": "Get paginated user followers", "tags": [ "Instagram" ], "description": "List the followers of an Instagram account, with each follower's username, full name, profile picture and whether they are private or verified. Page through the list with the `after` cursor. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Instagram username, e.g. instagram" }, "count": { "default": 10, "description": "Page size requested from Instagram (1–10). Defaults to 10. Instagram determines the number of results returned.", "type": "integer", "minimum": 1, "maximum": 10 }, "after": { "description": "Instagram cursor from the previous response’s end_cursor", "type": "string" } }, "required": [ "username" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "has_next_page": { "type": "boolean" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_private": { "default": false, "type": "boolean" }, "is_verified": { "default": false, "type": "boolean" } }, "required": [ "id", "username", "is_private", "is_verified" ], "additionalProperties": false } } }, "required": [ "has_next_page", "followers" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.instagram.getFollowers({\n username: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/instagram/following": { "post": { "summary": "Get paginated users followed by the user", "tags": [ "Instagram" ], "description": "List the accounts an Instagram user follows, with each account's username, full name, profile picture and whether it is private or verified. Page through the list with the `after` cursor. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Instagram username, e.g. instagram" }, "count": { "default": 10, "description": "Page size requested from Instagram (1–10). Defaults to 10. Instagram determines the number of results returned.", "type": "integer", "minimum": 1, "maximum": 10 }, "after": { "description": "Instagram cursor from the previous response’s end_cursor", "type": "string" } }, "required": [ "username" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "has_next_page": { "type": "boolean" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "following": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_private": { "default": false, "type": "boolean" }, "is_verified": { "default": false, "type": "boolean" } }, "required": [ "id", "username", "is_private", "is_verified" ], "additionalProperties": false } } }, "required": [ "has_next_page", "following" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.instagram.getFollowing({\n username: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/instagram/post": { "post": { "summary": "Get post details by shortcode", "tags": [ "Instagram" ], "description": "Get an Instagram post or Reel by its shortcode, the code in its link (instagram.com/p/). Returns the caption, image or video link, like and comment counts, timestamp and, for videos, the view count. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "shortcode": { "type": "string", "minLength": 1 } }, "required": [ "shortcode" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "shortcode": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "Image", "Video", "Carousel" ] }, "display_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "likes": { "default": 0, "type": "number" }, "comments": { "default": 0, "type": "number" }, "timestamp": { "type": "number" }, "is_video": { "default": false, "type": "boolean" }, "video_view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "shortcode", "url", "type", "likes", "comments", "timestamp", "is_video" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.instagram.getPost({\n shortcode: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/instagram/post-comments": { "post": { "summary": "Get comments on a post", "tags": [ "Instagram" ], "description": "List the comments on an Instagram post or Reel by its shortcode. Each comment includes the text, author, time posted and like count. Page through the comments with the `after` cursor. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "shortcode": { "type": "string", "minLength": 1 }, "count": { "default": 10, "description": "Page size requested from Instagram (1–10). Defaults to 10. Instagram determines the number of results returned.", "type": "integer", "minimum": 1, "maximum": 10 }, "after": { "description": "Instagram cursor from the previous response’s end_cursor", "type": "string" } }, "required": [ "shortcode" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "has_next_page": { "type": "boolean" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "created_at": { "type": "number" }, "owner": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_private": { "default": false, "type": "boolean" }, "is_verified": { "default": false, "type": "boolean" } }, "required": [ "id", "username", "is_private", "is_verified" ], "additionalProperties": false }, "likes_count": { "default": 0, "type": "number" } }, "required": [ "id", "text", "created_at", "owner", "likes_count" ], "additionalProperties": false } } }, "required": [ "has_next_page", "comments" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.instagram.getPostComments({\n shortcode: \"string\",\n count: 10,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/instagram/search-users": { "post": { "summary": "Search users", "tags": [ "Instagram" ], "description": "Search Instagram accounts by name or keyword. Each result includes the username, full name, bio, profile picture, follower and post counts, and whether the account is private, verified or a business. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1 } }, "required": [ "query" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "biography": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio_links": { "default": [], "type": "array", "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "link_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url" ], "additionalProperties": false } }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followers": { "default": 0, "type": "number" }, "following": { "default": 0, "type": "number" }, "posts_count": { "default": 0, "type": "number" }, "is_private": { "default": false, "type": "boolean" }, "is_verified": { "default": false, "type": "boolean" }, "is_business_account": { "default": false, "type": "boolean" }, "is_professional_account": { "default": false, "type": "boolean" }, "category_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "username", "bio_links", "followers", "following", "posts_count", "is_private", "is_verified", "is_business_account", "is_professional_account" ], "additionalProperties": false } } }, "required": [ "users" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.instagram.searchUsers({\n query: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-user": { "post": { "summary": "Fetch a TikTok user by username", "tags": [ "TikTok" ], "description": "Get a public TikTok profile by username: nickname, bio, avatar, verification status, whether the account is private and its comment, duet and stitch settings. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "uniqueId": { "type": "string", "pattern": "^@?[A-Za-z0-9_.]{1,24}$", "description": "TikTok username, with or without @, for example \"tiktok\"." } }, "required": [ "uniqueId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarThumb": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Small profile image URL." }, "avatarMedium": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Medium profile image URL." }, "avatarLarger": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Large profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "relation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Relationship to the viewing account, when available." }, "ftc": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether TikTok identifies this as an underage account." }, "openFavorite": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether liked videos are public." }, "commentSetting": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Comment permission setting." }, "duetSetting": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Duet permission setting." }, "stitchSetting": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Stitch permission setting." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "secret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether TikTok marks the account as hidden." }, "isADVirtual": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this is a virtual advertising account." }, "roomId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Live room ID, when available." }, "createTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Account creation time in Unix seconds." }, "bioLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Website linked from the biography." }, "commerceUser": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this is a business account." }, "commerceCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Business account category." }, "showMusicTab": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the profile displays a music tab." }, "showQuestionTab": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the profile displays a questions tab." }, "showPlayListTab": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the profile displays playlists." }, "uniqueIdModifyTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Last username change time in Unix seconds." }, "nickNameModifyTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Last display name change time in Unix seconds." }, "ttSeller": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is a TikTok Shop seller." }, "downloadSetting": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video download permission setting." }, "followingVisibility": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Visibility setting for the following list." }, "isEmbedBanned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether embedding is disabled." }, "canExpPlaylist": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether playlists are enabled." }, "profileEmbedPermission": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Profile embedding permission setting." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile language code." }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Account region code, when provided." }, "isOrganization": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Organization account classification, when provided." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." }, "diggCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of videos liked by the account." }, "friendCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of mutual followers." }, "storyStatus": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Story availability code reported by TikTok." }, "scheduledLiveEvents": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Scheduled live event ID." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Event title." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Event description." }, "startTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Scheduled start time in Unix seconds." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Scheduled duration, when provided." }, "status": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Event status code reported by TikTok." }, "eventType": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Event category code reported by TikTok." }, "subscriberCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of event subscribers." }, "subscribed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the viewing account has subscribed." }, "paid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the event requires payment." } }, "required": [ "id", "title", "description", "startTime", "duration", "status", "eventType", "subscriberCount", "subscribed", "paid" ], "additionalProperties": false } }, { "type": "null" } ], "description": "Scheduled live events, when provided." } }, "required": [ "id", "uniqueId", "nickname", "avatarThumb", "avatarMedium", "avatarLarger", "signature", "verified", "secUid", "relation", "ftc", "openFavorite", "commentSetting", "duetSetting", "stitchSetting", "privateAccount", "secret", "isADVirtual", "roomId", "createTime", "bioLink", "commerceUser", "commerceCategory", "showMusicTab", "showQuestionTab", "showPlayListTab", "uniqueIdModifyTime", "nickNameModifyTime", "ttSeller", "downloadSetting", "followingVisibility", "isEmbedBanned", "canExpPlaylist", "profileEmbedPermission", "language", "region", "isOrganization", "followerCount", "followingCount", "heartCount", "videoCount", "diggCount", "friendCount", "storyStatus", "scheduledLiveEvents" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getUser({\n uniqueId: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-user-posts": { "post": { "summary": "Get a TikTok user’s posts", "tags": [ "TikTok" ], "description": "List the videos and photo posts on a public TikTok account by username. Each post includes the caption, view, like, comment, share and save counts, sound, hashtags and cover image. Page through results with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "The previous response's `nextCursor`, to fetch the next page.", "type": "string" }, "uniqueId": { "type": "string", "pattern": "^@?[A-Za-z0-9_.]{1,24}$", "description": "TikTok username, with or without @, for example \"tiktok\"." }, "count": { "default": 35, "description": "Most results to return per page (1–35). Defaults to 35. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 35 } }, "required": [ "uniqueId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok post ID." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link to the post on TikTok." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption text." }, "createTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Publish time in Unix seconds." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption language code." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video length in seconds." }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video width in pixels." }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video height in pixels." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "animatedCoverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Animated cover image URL, when available." }, "images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Image URLs of a photo post; null for videos." }, "subtitles": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subtitle language, for example \"eng-US\"." }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File format, for example \"webvtt\"." }, "autoGenerated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether TikTok generated the subtitles from speech." }, "url": { "type": "string", "description": "Subtitle file URL." } }, "required": [ "language", "format", "autoGenerated", "url" ], "additionalProperties": false } }, { "type": "null" } ], "description": "Subtitle files, when the video has captions." }, "stats": { "type": "object", "properties": { "playCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of views." }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of likes." }, "commentCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of comments." }, "shareCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of shares." }, "saveCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post was saved to favorites." }, "repostCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of reposts." } }, "required": [ "playCount", "likeCount", "commentCount", "shareCount", "saveCount", "repostCount" ], "additionalProperties": false, "description": "Engagement counts." }, "author": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." } }, "required": [ "id", "uniqueId", "nickname", "avatarUrl", "signature", "verified", "secUid", "privateAccount", "followerCount", "followingCount", "heartCount", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The post’s creator." }, "sound": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sound ID." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sound title." }, "authorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the sound’s creator." }, "original": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this is an original sound recorded by a creator." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Length in seconds." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "playUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Audio file URL." }, "album": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Album name, when provided." }, "copyrighted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the sound is a licensed, copyrighted track." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of videos using the sound. Only returned when fetching a sound." } }, "required": [ "id", "title", "authorName", "original", "duration", "coverUrl", "playUrl", "album", "copyrighted", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The sound used in the post." }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtags in the caption, without the #." }, "mentions": { "type": "array", "items": { "type": "string" }, "description": "Usernames mentioned in the caption, without the @." }, "location": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok place ID." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place name." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street address." }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City name." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place category." } }, "required": [ "id", "name", "address", "city", "category" ], "additionalProperties": false }, { "type": "null" } ], "description": "Tagged place, when the creator added one." }, "playlistId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the creator playlist the post belongs to, if any." }, "isAd": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the post is an ad." }, "duetEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can duet the post." }, "stitchEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can stitch the post." } }, "required": [ "id", "url", "description", "createTime", "language", "duration", "width", "height", "coverUrl", "animatedCoverUrl", "images", "subtitles", "stats", "author", "sound", "hashtags", "mentions", "location", "playlistId", "isAd", "duetEnabled", "stitchEnabled" ], "additionalProperties": false }, "description": "Posts on this page." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "videos", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getUserPosts({\n uniqueId: \"string\",\n count: 35,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-user-liked-videos": { "post": { "summary": "Get the videos a TikTok user liked", "tags": [ "TikTok" ], "description": "List the posts a TikTok account liked, by username. Works for accounts that show their liked videos publicly. Page through results with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "The previous response's `nextCursor`, to fetch the next page.", "type": "string" }, "uniqueId": { "type": "string", "pattern": "^@?[A-Za-z0-9_.]{1,24}$", "description": "TikTok username, with or without @, for example \"tiktok\"." }, "count": { "default": 30, "description": "Most results to return per page (1–30). Defaults to 30. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 30 } }, "required": [ "uniqueId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok post ID." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link to the post on TikTok." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption text." }, "createTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Publish time in Unix seconds." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption language code." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video length in seconds." }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video width in pixels." }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video height in pixels." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "animatedCoverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Animated cover image URL, when available." }, "images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Image URLs of a photo post; null for videos." }, "subtitles": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subtitle language, for example \"eng-US\"." }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File format, for example \"webvtt\"." }, "autoGenerated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether TikTok generated the subtitles from speech." }, "url": { "type": "string", "description": "Subtitle file URL." } }, "required": [ "language", "format", "autoGenerated", "url" ], "additionalProperties": false } }, { "type": "null" } ], "description": "Subtitle files, when the video has captions." }, "stats": { "type": "object", "properties": { "playCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of views." }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of likes." }, "commentCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of comments." }, "shareCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of shares." }, "saveCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post was saved to favorites." }, "repostCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of reposts." } }, "required": [ "playCount", "likeCount", "commentCount", "shareCount", "saveCount", "repostCount" ], "additionalProperties": false, "description": "Engagement counts." }, "author": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." } }, "required": [ "id", "uniqueId", "nickname", "avatarUrl", "signature", "verified", "secUid", "privateAccount", "followerCount", "followingCount", "heartCount", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The post’s creator." }, "sound": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sound ID." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sound title." }, "authorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the sound’s creator." }, "original": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this is an original sound recorded by a creator." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Length in seconds." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "playUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Audio file URL." }, "album": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Album name, when provided." }, "copyrighted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the sound is a licensed, copyrighted track." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of videos using the sound. Only returned when fetching a sound." } }, "required": [ "id", "title", "authorName", "original", "duration", "coverUrl", "playUrl", "album", "copyrighted", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The sound used in the post." }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtags in the caption, without the #." }, "mentions": { "type": "array", "items": { "type": "string" }, "description": "Usernames mentioned in the caption, without the @." }, "location": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok place ID." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place name." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street address." }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City name." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place category." } }, "required": [ "id", "name", "address", "city", "category" ], "additionalProperties": false }, { "type": "null" } ], "description": "Tagged place, when the creator added one." }, "playlistId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the creator playlist the post belongs to, if any." }, "isAd": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the post is an ad." }, "duetEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can duet the post." }, "stitchEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can stitch the post." } }, "required": [ "id", "url", "description", "createTime", "language", "duration", "width", "height", "coverUrl", "animatedCoverUrl", "images", "subtitles", "stats", "author", "sound", "hashtags", "mentions", "location", "playlistId", "isAd", "duetEnabled", "stitchEnabled" ], "additionalProperties": false }, "description": "Posts on this page." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "videos", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getUserLikedVideos({\n uniqueId: \"string\",\n count: 30,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-user-reposts": { "post": { "summary": "Get the videos a TikTok user reposted", "tags": [ "TikTok" ], "description": "List the posts a TikTok account reposted to its followers, by username, each with its original creator. Page through results with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "The previous response's `nextCursor`, to fetch the next page.", "type": "string" }, "uniqueId": { "type": "string", "pattern": "^@?[A-Za-z0-9_.]{1,24}$", "description": "TikTok username, with or without @, for example \"tiktok\"." }, "count": { "default": 30, "description": "Most results to return per page (1–30). Defaults to 30. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 30 } }, "required": [ "uniqueId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok post ID." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link to the post on TikTok." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption text." }, "createTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Publish time in Unix seconds." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption language code." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video length in seconds." }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video width in pixels." }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video height in pixels." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "animatedCoverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Animated cover image URL, when available." }, "images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Image URLs of a photo post; null for videos." }, "subtitles": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subtitle language, for example \"eng-US\"." }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File format, for example \"webvtt\"." }, "autoGenerated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether TikTok generated the subtitles from speech." }, "url": { "type": "string", "description": "Subtitle file URL." } }, "required": [ "language", "format", "autoGenerated", "url" ], "additionalProperties": false } }, { "type": "null" } ], "description": "Subtitle files, when the video has captions." }, "stats": { "type": "object", "properties": { "playCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of views." }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of likes." }, "commentCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of comments." }, "shareCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of shares." }, "saveCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post was saved to favorites." }, "repostCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of reposts." } }, "required": [ "playCount", "likeCount", "commentCount", "shareCount", "saveCount", "repostCount" ], "additionalProperties": false, "description": "Engagement counts." }, "author": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." } }, "required": [ "id", "uniqueId", "nickname", "avatarUrl", "signature", "verified", "secUid", "privateAccount", "followerCount", "followingCount", "heartCount", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The post’s creator." }, "sound": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sound ID." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sound title." }, "authorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the sound’s creator." }, "original": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this is an original sound recorded by a creator." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Length in seconds." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "playUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Audio file URL." }, "album": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Album name, when provided." }, "copyrighted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the sound is a licensed, copyrighted track." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of videos using the sound. Only returned when fetching a sound." } }, "required": [ "id", "title", "authorName", "original", "duration", "coverUrl", "playUrl", "album", "copyrighted", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The sound used in the post." }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtags in the caption, without the #." }, "mentions": { "type": "array", "items": { "type": "string" }, "description": "Usernames mentioned in the caption, without the @." }, "location": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok place ID." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place name." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street address." }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City name." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place category." } }, "required": [ "id", "name", "address", "city", "category" ], "additionalProperties": false }, { "type": "null" } ], "description": "Tagged place, when the creator added one." }, "playlistId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the creator playlist the post belongs to, if any." }, "isAd": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the post is an ad." }, "duetEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can duet the post." }, "stitchEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can stitch the post." } }, "required": [ "id", "url", "description", "createTime", "language", "duration", "width", "height", "coverUrl", "animatedCoverUrl", "images", "subtitles", "stats", "author", "sound", "hashtags", "mentions", "location", "playlistId", "isAd", "duetEnabled", "stitchEnabled" ], "additionalProperties": false }, "description": "Posts on this page." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "videos", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getUserReposts({\n uniqueId: \"string\",\n count: 30,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-user-followers": { "post": { "summary": "Get a TikTok user’s followers", "tags": [ "TikTok" ], "description": "List the followers of a public TikTok account by username, with each follower’s username, nickname, bio, avatar and follower counts. Page through results with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "The previous response's `nextCursor`, to fetch the next page.", "type": "string" }, "uniqueId": { "type": "string", "pattern": "^@?[A-Za-z0-9_.]{1,24}$", "description": "TikTok username, with or without @, for example \"tiktok\"." }, "count": { "default": 30, "description": "Most results to return per page (1–30). Defaults to 30. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 30 } }, "required": [ "uniqueId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." } }, "required": [ "id", "uniqueId", "nickname", "avatarUrl", "signature", "verified", "secUid", "privateAccount", "followerCount", "followingCount", "heartCount", "videoCount" ], "additionalProperties": false }, "description": "Accounts on this page." }, "total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of accounts in the list, when provided." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "users", "total", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getUserFollowers({\n uniqueId: \"string\",\n count: 30,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-user-following": { "post": { "summary": "Get the accounts a TikTok user follows", "tags": [ "TikTok" ], "description": "List the accounts a public TikTok user follows, by username, with each account’s username, nickname, bio, avatar and follower counts. Page through results with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "The previous response's `nextCursor`, to fetch the next page.", "type": "string" }, "uniqueId": { "type": "string", "pattern": "^@?[A-Za-z0-9_.]{1,24}$", "description": "TikTok username, with or without @, for example \"tiktok\"." }, "count": { "default": 30, "description": "Most results to return per page (1–30). Defaults to 30. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 30 } }, "required": [ "uniqueId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." } }, "required": [ "id", "uniqueId", "nickname", "avatarUrl", "signature", "verified", "secUid", "privateAccount", "followerCount", "followingCount", "heartCount", "videoCount" ], "additionalProperties": false }, "description": "Accounts on this page." }, "total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of accounts in the list, when provided." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "users", "total", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getUserFollowing({\n uniqueId: \"string\",\n count: 30,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-user-playlists": { "post": { "summary": "Get a TikTok user’s playlists", "tags": [ "TikTok" ], "description": "List the playlists a TikTok creator made, by username, with each playlist’s ID, name, cover and number of posts. Page through results with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "The previous response's `nextCursor`, to fetch the next page.", "type": "string" }, "uniqueId": { "type": "string", "pattern": "^@?[A-Za-z0-9_.]{1,24}$", "description": "TikTok username, with or without @, for example \"tiktok\"." }, "count": { "default": 30, "description": "Most results to return per page (1–30). Defaults to 30. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 30 } }, "required": [ "uniqueId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "playlists": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok playlist ID." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Playlist name." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of posts in the playlist." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." } }, "required": [ "id", "name", "videoCount", "coverUrl" ], "additionalProperties": false }, "description": "Playlists on this page." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "playlists", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getUserPlaylists({\n uniqueId: \"string\",\n count: 30,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-playlist-videos": { "post": { "summary": "Get the videos in a TikTok playlist", "tags": [ "TikTok" ], "description": "List the posts in a TikTok creator playlist by playlist ID, in playlist order. Page through results with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "The previous response's `nextCursor`, to fetch the next page.", "type": "string" }, "playlistId": { "type": "string", "pattern": "^\\d{1,30}$", "description": "Playlist ID, as returned by `getUserPlaylists`." }, "count": { "default": 20, "description": "Most results to return per page (1–20). Defaults to 20. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 20 } }, "required": [ "playlistId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok post ID." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link to the post on TikTok." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption text." }, "createTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Publish time in Unix seconds." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption language code." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video length in seconds." }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video width in pixels." }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video height in pixels." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "animatedCoverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Animated cover image URL, when available." }, "images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Image URLs of a photo post; null for videos." }, "subtitles": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subtitle language, for example \"eng-US\"." }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File format, for example \"webvtt\"." }, "autoGenerated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether TikTok generated the subtitles from speech." }, "url": { "type": "string", "description": "Subtitle file URL." } }, "required": [ "language", "format", "autoGenerated", "url" ], "additionalProperties": false } }, { "type": "null" } ], "description": "Subtitle files, when the video has captions." }, "stats": { "type": "object", "properties": { "playCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of views." }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of likes." }, "commentCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of comments." }, "shareCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of shares." }, "saveCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post was saved to favorites." }, "repostCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of reposts." } }, "required": [ "playCount", "likeCount", "commentCount", "shareCount", "saveCount", "repostCount" ], "additionalProperties": false, "description": "Engagement counts." }, "author": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." } }, "required": [ "id", "uniqueId", "nickname", "avatarUrl", "signature", "verified", "secUid", "privateAccount", "followerCount", "followingCount", "heartCount", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The post’s creator." }, "sound": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sound ID." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sound title." }, "authorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the sound’s creator." }, "original": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this is an original sound recorded by a creator." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Length in seconds." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "playUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Audio file URL." }, "album": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Album name, when provided." }, "copyrighted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the sound is a licensed, copyrighted track." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of videos using the sound. Only returned when fetching a sound." } }, "required": [ "id", "title", "authorName", "original", "duration", "coverUrl", "playUrl", "album", "copyrighted", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The sound used in the post." }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtags in the caption, without the #." }, "mentions": { "type": "array", "items": { "type": "string" }, "description": "Usernames mentioned in the caption, without the @." }, "location": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok place ID." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place name." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street address." }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City name." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place category." } }, "required": [ "id", "name", "address", "city", "category" ], "additionalProperties": false }, { "type": "null" } ], "description": "Tagged place, when the creator added one." }, "playlistId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the creator playlist the post belongs to, if any." }, "isAd": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the post is an ad." }, "duetEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can duet the post." }, "stitchEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can stitch the post." } }, "required": [ "id", "url", "description", "createTime", "language", "duration", "width", "height", "coverUrl", "animatedCoverUrl", "images", "subtitles", "stats", "author", "sound", "hashtags", "mentions", "location", "playlistId", "isAd", "duetEnabled", "stitchEnabled" ], "additionalProperties": false }, "description": "Posts on this page." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "videos", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getPlaylistVideos({\n playlistId: \"string\",\n count: 20,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-video": { "post": { "summary": "Fetch a TikTok video by ID", "tags": [ "TikTok" ], "description": "Get a TikTok video or photo post by ID: caption, view, like, comment, share and save counts, creator, sound, hashtags, mentions, tagged place, cover image and subtitle files. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "videoId": { "type": "string", "pattern": "^\\d{1,30}$", "description": "Post ID, the number at the end of the post URL, for example \"7698770783367171359\"." } }, "required": [ "videoId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok post ID." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link to the post on TikTok." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption text." }, "createTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Publish time in Unix seconds." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption language code." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video length in seconds." }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video width in pixels." }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video height in pixels." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "animatedCoverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Animated cover image URL, when available." }, "images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Image URLs of a photo post; null for videos." }, "subtitles": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subtitle language, for example \"eng-US\"." }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File format, for example \"webvtt\"." }, "autoGenerated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether TikTok generated the subtitles from speech." }, "url": { "type": "string", "description": "Subtitle file URL." } }, "required": [ "language", "format", "autoGenerated", "url" ], "additionalProperties": false } }, { "type": "null" } ], "description": "Subtitle files, when the video has captions." }, "stats": { "type": "object", "properties": { "playCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of views." }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of likes." }, "commentCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of comments." }, "shareCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of shares." }, "saveCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post was saved to favorites." }, "repostCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of reposts." } }, "required": [ "playCount", "likeCount", "commentCount", "shareCount", "saveCount", "repostCount" ], "additionalProperties": false, "description": "Engagement counts." }, "author": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." } }, "required": [ "id", "uniqueId", "nickname", "avatarUrl", "signature", "verified", "secUid", "privateAccount", "followerCount", "followingCount", "heartCount", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The post’s creator." }, "sound": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sound ID." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sound title." }, "authorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the sound’s creator." }, "original": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this is an original sound recorded by a creator." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Length in seconds." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "playUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Audio file URL." }, "album": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Album name, when provided." }, "copyrighted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the sound is a licensed, copyrighted track." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of videos using the sound. Only returned when fetching a sound." } }, "required": [ "id", "title", "authorName", "original", "duration", "coverUrl", "playUrl", "album", "copyrighted", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The sound used in the post." }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtags in the caption, without the #." }, "mentions": { "type": "array", "items": { "type": "string" }, "description": "Usernames mentioned in the caption, without the @." }, "location": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok place ID." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place name." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street address." }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City name." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place category." } }, "required": [ "id", "name", "address", "city", "category" ], "additionalProperties": false }, { "type": "null" } ], "description": "Tagged place, when the creator added one." }, "playlistId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the creator playlist the post belongs to, if any." }, "isAd": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the post is an ad." }, "duetEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can duet the post." }, "stitchEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can stitch the post." } }, "required": [ "id", "url", "description", "createTime", "language", "duration", "width", "height", "coverUrl", "animatedCoverUrl", "images", "subtitles", "stats", "author", "sound", "hashtags", "mentions", "location", "playlistId", "isAd", "duetEnabled", "stitchEnabled" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getVideo({\n videoId: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-video-comments": { "post": { "summary": "Get the comments on a TikTok video", "tags": [ "TikTok" ], "description": "List the top-level comments on a TikTok post by ID, with each comment’s text, like and reply counts, author and whether the creator liked or pinned it. Page through results with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "The previous response's `nextCursor`, to fetch the next page.", "type": "string" }, "videoId": { "type": "string", "pattern": "^\\d{1,30}$", "description": "Post ID, the number at the end of the post URL, for example \"7698770783367171359\"." }, "count": { "default": 20, "description": "Most results to return per page (1–20). Defaults to 20. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 20 } }, "required": [ "videoId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok comment ID." }, "videoId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the commented post." }, "parentCommentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the comment this replies to; null for top-level comments." }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comment text." }, "createTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Comment time in Unix seconds." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comment language code." }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of likes." }, "replyCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of replies." }, "likedByCreator": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the post’s creator liked the comment." }, "pinnedByCreator": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the post’s creator pinned the comment." }, "author": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." } }, "required": [ "id", "uniqueId", "nickname", "avatarUrl", "signature", "verified", "secUid", "privateAccount", "followerCount", "followingCount", "heartCount", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "Comment author." } }, "required": [ "id", "videoId", "parentCommentId", "text", "createTime", "language", "likeCount", "replyCount", "likedByCreator", "pinnedByCreator", "author" ], "additionalProperties": false }, "description": "Comments on this page." }, "total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of comments, when provided." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "comments", "total", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getVideoComments({\n videoId: \"string\",\n count: 20,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-comment-replies": { "post": { "summary": "Get the replies to a TikTok comment", "tags": [ "TikTok" ], "description": "List the replies to a comment on a TikTok post, with each reply’s text, like count and author. Page through results with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "The previous response's `nextCursor`, to fetch the next page.", "type": "string" }, "videoId": { "type": "string", "pattern": "^\\d{1,30}$", "description": "Post ID, the number at the end of the post URL, for example \"7698770783367171359\"." }, "count": { "default": 20, "description": "Most results to return per page (1–20). Defaults to 20. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 20 }, "commentId": { "type": "string", "pattern": "^\\d{1,30}$", "description": "ID of the comment whose replies to list." } }, "required": [ "videoId", "commentId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok comment ID." }, "videoId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the commented post." }, "parentCommentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the comment this replies to; null for top-level comments." }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comment text." }, "createTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Comment time in Unix seconds." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comment language code." }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of likes." }, "replyCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of replies." }, "likedByCreator": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the post’s creator liked the comment." }, "pinnedByCreator": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the post’s creator pinned the comment." }, "author": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." } }, "required": [ "id", "uniqueId", "nickname", "avatarUrl", "signature", "verified", "secUid", "privateAccount", "followerCount", "followingCount", "heartCount", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "Comment author." } }, "required": [ "id", "videoId", "parentCommentId", "text", "createTime", "language", "likeCount", "replyCount", "likedByCreator", "pinnedByCreator", "author" ], "additionalProperties": false }, "description": "Comments on this page." }, "total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of comments, when provided." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "comments", "total", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getCommentReplies({\n videoId: \"string\",\n count: 20,\n commentId: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-related-videos": { "post": { "summary": "Get videos related to a TikTok video", "tags": [ "TikTok" ], "description": "Get the posts TikTok recommends alongside a post, by post ID. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "videoId": { "type": "string", "pattern": "^\\d{1,30}$", "description": "Post ID, the number at the end of the post URL, for example \"7698770783367171359\"." } }, "required": [ "videoId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok post ID." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link to the post on TikTok." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption text." }, "createTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Publish time in Unix seconds." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption language code." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video length in seconds." }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video width in pixels." }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video height in pixels." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "animatedCoverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Animated cover image URL, when available." }, "images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Image URLs of a photo post; null for videos." }, "subtitles": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subtitle language, for example \"eng-US\"." }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File format, for example \"webvtt\"." }, "autoGenerated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether TikTok generated the subtitles from speech." }, "url": { "type": "string", "description": "Subtitle file URL." } }, "required": [ "language", "format", "autoGenerated", "url" ], "additionalProperties": false } }, { "type": "null" } ], "description": "Subtitle files, when the video has captions." }, "stats": { "type": "object", "properties": { "playCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of views." }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of likes." }, "commentCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of comments." }, "shareCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of shares." }, "saveCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post was saved to favorites." }, "repostCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of reposts." } }, "required": [ "playCount", "likeCount", "commentCount", "shareCount", "saveCount", "repostCount" ], "additionalProperties": false, "description": "Engagement counts." }, "author": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." } }, "required": [ "id", "uniqueId", "nickname", "avatarUrl", "signature", "verified", "secUid", "privateAccount", "followerCount", "followingCount", "heartCount", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The post’s creator." }, "sound": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sound ID." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sound title." }, "authorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the sound’s creator." }, "original": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this is an original sound recorded by a creator." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Length in seconds." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "playUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Audio file URL." }, "album": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Album name, when provided." }, "copyrighted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the sound is a licensed, copyrighted track." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of videos using the sound. Only returned when fetching a sound." } }, "required": [ "id", "title", "authorName", "original", "duration", "coverUrl", "playUrl", "album", "copyrighted", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The sound used in the post." }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtags in the caption, without the #." }, "mentions": { "type": "array", "items": { "type": "string" }, "description": "Usernames mentioned in the caption, without the @." }, "location": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok place ID." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place name." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street address." }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City name." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place category." } }, "required": [ "id", "name", "address", "city", "category" ], "additionalProperties": false }, { "type": "null" } ], "description": "Tagged place, when the creator added one." }, "playlistId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the creator playlist the post belongs to, if any." }, "isAd": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the post is an ad." }, "duetEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can duet the post." }, "stitchEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can stitch the post." } }, "required": [ "id", "url", "description", "createTime", "language", "duration", "width", "height", "coverUrl", "animatedCoverUrl", "images", "subtitles", "stats", "author", "sound", "hashtags", "mentions", "location", "playlistId", "isAd", "duetEnabled", "stitchEnabled" ], "additionalProperties": false }, "description": "Posts TikTok recommends alongside the post." } }, "required": [ "videos" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getRelatedVideos({\n videoId: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-hashtag": { "post": { "summary": "Fetch a TikTok hashtag", "tags": [ "TikTok" ], "description": "Look up a TikTok hashtag by name and get its ID, description, number of videos and total views. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "hashtag": { "type": "string", "minLength": 1, "maxLength": 100, "description": "Hashtag name, with or without #, for example \"cooking\"." } }, "required": [ "hashtag" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok hashtag ID." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hashtag name without the #." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Hashtag description." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL, when set." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of videos using the hashtag." }, "viewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total views of videos using the hashtag." }, "commerce": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the hashtag is a sponsored campaign." } }, "required": [ "id", "name", "description", "coverUrl", "videoCount", "viewCount", "commerce" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getHashtag({\n hashtag: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-hashtag-videos": { "post": { "summary": "Get the videos for a TikTok hashtag", "tags": [ "TikTok" ], "description": "List the posts made with a TikTok hashtag, by hashtag name, in the order TikTok shows them on the hashtag page. Page through results with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "The previous response's `nextCursor`, to fetch the next page.", "type": "string" }, "hashtag": { "type": "string", "minLength": 1, "maxLength": 100, "description": "Hashtag name, with or without #, for example \"cooking\"." }, "count": { "default": 30, "description": "Most results to return per page (1–30). Defaults to 30. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 30 } }, "required": [ "hashtag" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok post ID." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link to the post on TikTok." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption text." }, "createTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Publish time in Unix seconds." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption language code." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video length in seconds." }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video width in pixels." }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video height in pixels." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "animatedCoverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Animated cover image URL, when available." }, "images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Image URLs of a photo post; null for videos." }, "subtitles": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subtitle language, for example \"eng-US\"." }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File format, for example \"webvtt\"." }, "autoGenerated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether TikTok generated the subtitles from speech." }, "url": { "type": "string", "description": "Subtitle file URL." } }, "required": [ "language", "format", "autoGenerated", "url" ], "additionalProperties": false } }, { "type": "null" } ], "description": "Subtitle files, when the video has captions." }, "stats": { "type": "object", "properties": { "playCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of views." }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of likes." }, "commentCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of comments." }, "shareCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of shares." }, "saveCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post was saved to favorites." }, "repostCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of reposts." } }, "required": [ "playCount", "likeCount", "commentCount", "shareCount", "saveCount", "repostCount" ], "additionalProperties": false, "description": "Engagement counts." }, "author": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." } }, "required": [ "id", "uniqueId", "nickname", "avatarUrl", "signature", "verified", "secUid", "privateAccount", "followerCount", "followingCount", "heartCount", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The post’s creator." }, "sound": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sound ID." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sound title." }, "authorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the sound’s creator." }, "original": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this is an original sound recorded by a creator." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Length in seconds." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "playUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Audio file URL." }, "album": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Album name, when provided." }, "copyrighted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the sound is a licensed, copyrighted track." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of videos using the sound. Only returned when fetching a sound." } }, "required": [ "id", "title", "authorName", "original", "duration", "coverUrl", "playUrl", "album", "copyrighted", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The sound used in the post." }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtags in the caption, without the #." }, "mentions": { "type": "array", "items": { "type": "string" }, "description": "Usernames mentioned in the caption, without the @." }, "location": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok place ID." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place name." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street address." }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City name." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place category." } }, "required": [ "id", "name", "address", "city", "category" ], "additionalProperties": false }, { "type": "null" } ], "description": "Tagged place, when the creator added one." }, "playlistId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the creator playlist the post belongs to, if any." }, "isAd": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the post is an ad." }, "duetEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can duet the post." }, "stitchEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can stitch the post." } }, "required": [ "id", "url", "description", "createTime", "language", "duration", "width", "height", "coverUrl", "animatedCoverUrl", "images", "subtitles", "stats", "author", "sound", "hashtags", "mentions", "location", "playlistId", "isAd", "duetEnabled", "stitchEnabled" ], "additionalProperties": false }, "description": "Posts on this page." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "videos", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getHashtagVideos({\n hashtag: \"string\",\n count: 30,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-sound": { "post": { "summary": "Fetch a TikTok sound by ID", "tags": [ "TikTok" ], "description": "Get a TikTok sound by ID: title, artist, duration, cover image, audio link, whether it is an original sound and how many videos use it. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "soundId": { "type": "string", "pattern": "^\\d{1,30}$", "description": "Sound ID, the number at the end of the sound URL or a post’s `sound.id`." } }, "required": [ "soundId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sound ID." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sound title." }, "authorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the sound’s creator." }, "original": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this is an original sound recorded by a creator." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Length in seconds." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "playUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Audio file URL." }, "album": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Album name, when provided." }, "copyrighted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the sound is a licensed, copyrighted track." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of videos using the sound. Only returned when fetching a sound." } }, "required": [ "id", "title", "authorName", "original", "duration", "coverUrl", "playUrl", "album", "copyrighted", "videoCount" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getSound({\n soundId: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/get-sound-videos": { "post": { "summary": "Get the videos that use a TikTok sound", "tags": [ "TikTok" ], "description": "List the posts that use a TikTok sound, by sound ID, in the order TikTok shows them on the sound’s page. Page through results with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "The previous response's `nextCursor`, to fetch the next page.", "type": "string" }, "soundId": { "type": "string", "pattern": "^\\d{1,30}$", "description": "Sound ID, the number at the end of the sound URL or a post’s `sound.id`." }, "count": { "default": 30, "description": "Most results to return per page (1–30). Defaults to 30. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 30 } }, "required": [ "soundId" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok post ID." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link to the post on TikTok." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption text." }, "createTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Publish time in Unix seconds." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption language code." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video length in seconds." }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video width in pixels." }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video height in pixels." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "animatedCoverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Animated cover image URL, when available." }, "images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Image URLs of a photo post; null for videos." }, "subtitles": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subtitle language, for example \"eng-US\"." }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File format, for example \"webvtt\"." }, "autoGenerated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether TikTok generated the subtitles from speech." }, "url": { "type": "string", "description": "Subtitle file URL." } }, "required": [ "language", "format", "autoGenerated", "url" ], "additionalProperties": false } }, { "type": "null" } ], "description": "Subtitle files, when the video has captions." }, "stats": { "type": "object", "properties": { "playCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of views." }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of likes." }, "commentCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of comments." }, "shareCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of shares." }, "saveCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post was saved to favorites." }, "repostCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of reposts." } }, "required": [ "playCount", "likeCount", "commentCount", "shareCount", "saveCount", "repostCount" ], "additionalProperties": false, "description": "Engagement counts." }, "author": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." } }, "required": [ "id", "uniqueId", "nickname", "avatarUrl", "signature", "verified", "secUid", "privateAccount", "followerCount", "followingCount", "heartCount", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The post’s creator." }, "sound": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sound ID." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sound title." }, "authorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the sound’s creator." }, "original": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this is an original sound recorded by a creator." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Length in seconds." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "playUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Audio file URL." }, "album": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Album name, when provided." }, "copyrighted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the sound is a licensed, copyrighted track." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of videos using the sound. Only returned when fetching a sound." } }, "required": [ "id", "title", "authorName", "original", "duration", "coverUrl", "playUrl", "album", "copyrighted", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The sound used in the post." }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtags in the caption, without the #." }, "mentions": { "type": "array", "items": { "type": "string" }, "description": "Usernames mentioned in the caption, without the @." }, "location": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok place ID." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place name." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street address." }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City name." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place category." } }, "required": [ "id", "name", "address", "city", "category" ], "additionalProperties": false }, { "type": "null" } ], "description": "Tagged place, when the creator added one." }, "playlistId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the creator playlist the post belongs to, if any." }, "isAd": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the post is an ad." }, "duetEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can duet the post." }, "stitchEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can stitch the post." } }, "required": [ "id", "url", "description", "createTime", "language", "duration", "width", "height", "coverUrl", "animatedCoverUrl", "images", "subtitles", "stats", "author", "sound", "hashtags", "mentions", "location", "playlistId", "isAd", "duetEnabled", "stitchEnabled" ], "additionalProperties": false }, "description": "Posts on this page." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "videos", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.getSoundVideos({\n soundId: \"string\",\n count: 30,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/search-users": { "post": { "summary": "Search TikTok accounts", "tags": [ "TikTok" ], "description": "Find TikTok accounts by keyword, with each account’s username, nickname, bio, avatar, follower and like counts and verification status. Page through results with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "The previous response's `nextCursor`, to fetch the next page.", "type": "string" }, "query": { "type": "string", "minLength": 1, "maxLength": 100, "description": "Search keywords, for example \"street food\"." } }, "required": [ "query" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." } }, "required": [ "id", "uniqueId", "nickname", "avatarUrl", "signature", "verified", "secUid", "privateAccount", "followerCount", "followingCount", "heartCount", "videoCount" ], "additionalProperties": false }, "description": "Accounts on this page." }, "total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total number of accounts in the list, when provided." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "users", "total", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.searchUsers({\n query: \"string\",\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/tiktok/search-videos": { "post": { "summary": "Search TikTok videos", "tags": [ "TikTok" ], "description": "Search TikTok posts by keyword. Each result includes the caption, view, like, comment and share counts, creator, sound and hashtags. Page through results with the `cursor` from the previous response's `nextCursor`. Costs 1 credit per result returned, with a minimum of 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cursor": { "description": "The previous response's `nextCursor`, to fetch the next page.", "type": "string" }, "query": { "type": "string", "minLength": 1, "maxLength": 100, "description": "Search keywords, for example \"street food\"." }, "count": { "default": 30, "description": "Most results to return per page (1–30). Defaults to 30. A page can hold fewer, so keep paging while `nextCursor` is set.", "type": "integer", "minimum": 1, "maximum": 30 } }, "required": [ "query" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok post ID." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link to the post on TikTok." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption text." }, "createTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Publish time in Unix seconds." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caption language code." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video length in seconds." }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video width in pixels." }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video height in pixels." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "animatedCoverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Animated cover image URL, when available." }, "images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Image URLs of a photo post; null for videos." }, "subtitles": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Subtitle language, for example \"eng-US\"." }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "File format, for example \"webvtt\"." }, "autoGenerated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether TikTok generated the subtitles from speech." }, "url": { "type": "string", "description": "Subtitle file URL." } }, "required": [ "language", "format", "autoGenerated", "url" ], "additionalProperties": false } }, { "type": "null" } ], "description": "Subtitle files, when the video has captions." }, "stats": { "type": "object", "properties": { "playCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of views." }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of likes." }, "commentCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of comments." }, "shareCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of shares." }, "saveCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of times the post was saved to favorites." }, "repostCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of reposts." } }, "required": [ "playCount", "likeCount", "commentCount", "shareCount", "saveCount", "repostCount" ], "additionalProperties": false, "description": "Engagement counts." }, "author": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok account ID." }, "uniqueId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Username without the @ prefix." }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name." }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile image URL." }, "signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Profile biography." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is verified." }, "secUid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok secondary account identifier." }, "privateAccount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the account is private." }, "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of followers." }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of accounts followed." }, "heartCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total likes received." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of published videos." } }, "required": [ "id", "uniqueId", "nickname", "avatarUrl", "signature", "verified", "secUid", "privateAccount", "followerCount", "followingCount", "heartCount", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The post’s creator." }, "sound": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "TikTok sound ID." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sound title." }, "authorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the sound’s creator." }, "original": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this is an original sound recorded by a creator." }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Length in seconds." }, "coverUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cover image URL." }, "playUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Audio file URL." }, "album": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Album name, when provided." }, "copyrighted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the sound is a licensed, copyrighted track." }, "videoCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Number of videos using the sound. Only returned when fetching a sound." } }, "required": [ "id", "title", "authorName", "original", "duration", "coverUrl", "playUrl", "album", "copyrighted", "videoCount" ], "additionalProperties": false }, { "type": "null" } ], "description": "The sound used in the post." }, "hashtags": { "type": "array", "items": { "type": "string" }, "description": "Hashtags in the caption, without the #." }, "mentions": { "type": "array", "items": { "type": "string" }, "description": "Usernames mentioned in the caption, without the @." }, "location": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "TikTok place ID." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place name." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street address." }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City name." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Place category." } }, "required": [ "id", "name", "address", "city", "category" ], "additionalProperties": false }, { "type": "null" } ], "description": "Tagged place, when the creator added one." }, "playlistId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ID of the creator playlist the post belongs to, if any." }, "isAd": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the post is an ad." }, "duetEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can duet the post." }, "stitchEnabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether others can stitch the post." } }, "required": [ "id", "url", "description", "createTime", "language", "duration", "width", "height", "coverUrl", "animatedCoverUrl", "images", "subtitles", "stats", "author", "sound", "hashtags", "mentions", "location", "playlistId", "isAd", "duetEnabled", "stitchEnabled" ], "additionalProperties": false }, "description": "Posts on this page." }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass as `cursor` to fetch the next page; null when there are no more results." } }, "required": [ "videos", "nextCursor" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.tiktok.searchVideos({\n query: \"string\",\n count: 30,\n});\nif (res.type === 'success') console.log(res.data);" } ] } }, "/youtube/get-video": { "post": { "summary": "Fetch a video's full details and transcript from its YouTube link", "tags": [ "YouTube" ], "description": "Get a YouTube video's details from any video link, including Shorts and live streams: title, description, channel, duration, view and like counts, publish date, keywords and thumbnails, plus its timed transcript in the language you choose. Costs 1 credit per request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1, "description": "The video to fetch. Accepts any YouTube video link — watch, youtu.be, Shorts, embed, or live — or a bare 11-character video ID." }, "includeTranscript": { "default": true, "description": "Whether to also fetch the timed transcript in the same call. Defaults to true.", "type": "boolean" }, "transcriptLanguage": { "description": "Preferred transcript language as a BCP-47 code, e.g. \"en\" or \"pt-BR\". Defaults to the video's own default caption track.", "type": "string" } }, "required": [ "url" ] } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timeMs": { "type": "number", "description": "Wall-clock time the request took to complete, in milliseconds." }, "creditsCost": { "type": "number", "description": "Number of account credits this request consumed." }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "The 11-character video ID, e.g. \"dQw4w9WgXcQ\"." }, "url": { "type": "string", "description": "Canonical watch URL for the video." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Video title." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Full video description, with line breaks preserved." }, "durationSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Video length in seconds." }, "viewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Lifetime view count." }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Like count, when the uploader has not hidden it." }, "publishedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO 8601 timestamp of when the video was published." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "YouTube category of the video, e.g. \"Music\"." }, "keywords": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Uploader-supplied tags on the video." }, "thumbnails": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Direct image URL for this thumbnail size." }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Thumbnail width in pixels." }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Thumbnail height in pixels." } }, "required": [ "url", "width", "height" ], "additionalProperties": false } }, { "type": "null" } ], "description": "Available thumbnail sizes, smallest first." }, "channel": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Channel ID that owns the video, e.g. \"UCuAXFkgsw1L7xaCfnd5JJOw\"." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Channel display name, e.g. \"Rick Astley\"." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Channel page URL, e.g. \"https://www.youtube.com/@RickAstleyYT\"." }, "handle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Channel handle without the \"@\", e.g. \"RickAstleyYT\"." } }, "required": [ "id", "name", "url", "handle" ], "additionalProperties": false }, { "type": "null" } ], "description": "The channel that published the video." }, "isLive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "True when the video is a live broadcast." }, "isPrivate": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "True when the video is private." }, "isUnlisted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "True when the video is unlisted." }, "isFamilySafe": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "True when YouTube marks the video as family safe." }, "captionTracks": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "description": "BCP-47 language code of the track, e.g. \"en\" or \"pt-BR\"." }, "languageName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Human-readable language name, e.g. \"English\"." }, "isAutoGenerated": { "type": "boolean", "description": "True when the track was auto-generated by speech recognition rather than authored." } }, "required": [ "languageCode", "languageName", "isAutoGenerated" ], "additionalProperties": false } }, { "type": "null" } ], "description": "Caption tracks available on the video, in any language." }, "transcript": { "anyOf": [ { "type": "object", "properties": { "languageCode": { "type": "string", "description": "BCP-47 language code of the returned transcript, e.g. \"en\"." }, "isAutoGenerated": { "type": "boolean", "description": "True when this transcript came from an auto-generated track." }, "text": { "type": "string", "description": "The full transcript as a single newline-joined string." }, "segments": { "type": "array", "items": { "type": "object", "properties": { "startMs": { "type": "number", "description": "Offset from the start of the video, in milliseconds." }, "durationMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "How long this line stays on screen, in milliseconds." }, "text": { "type": "string", "description": "The spoken text for this segment." } }, "required": [ "startMs", "durationMs", "text" ], "additionalProperties": false }, "description": "Timed transcript lines, in playback order." } }, "required": [ "languageCode", "isAutoGenerated", "text", "segments" ], "additionalProperties": false }, { "type": "null" } ], "description": "The timed transcript, when one was requested and the video has captions." } }, "required": [ "id", "url", "title", "description", "durationSeconds", "viewCount", "likeCount", "publishedAt", "category", "keywords", "thumbnails", "channel", "isLive", "isPrivate", "isUnlisted", "isFamilySafe", "captionTracks", "transcript" ], "additionalProperties": false } }, "required": [ "timeMs", "creditsCost", "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "402": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "description": "Human-readable description of what went wrong." } }, "required": [ "status", "message" ], "additionalProperties": false } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "Bridgly SDK", "source": "import { Bridgly } from '@bridgly/sdk';\n\nconst client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });\n\nconst res = await client.youtube.getVideo({\n url: \"string\",\n includeTranscript: true,\n});\nif (res.type === 'success') console.log(res.data);" } ] } } }, "servers": [ { "url": "https://api.bridgly.app", "description": "Production" } ], "tags": [ { "name": "LinkedIn", "description": "Scrape LinkedIn profiles, companies, posts, and search." }, { "name": "Reddit", "description": "Scrape Reddit posts, subreddits, users, and search." }, { "name": "X (Twitter)", "description": "Scrape tweets and search X." }, { "name": "GitHub", "description": "Fetch GitHub profiles, pinned repos, contributions, repositories, stars, and projects via GitHub's GraphQL API." }, { "name": "Instagram", "description": "Scrape Instagram profiles, posts, followers, and search." }, { "name": "TikTok", "description": "Fetch TikTok profiles." } ] }