InsightSocial
GET /v1/huggingface/search/readmesbeta

Hugging Face Search Readmes API

Search the text of Hugging Face READMEs and code files.

20 credits a call · cursor pagination · failed calls free · 10 free calls to start

curl "https://api.insightsocial.app/v1/huggingface/search/readmes?query=<query>" \
-H "x-api-key: $INSIGHTSOCIAL_API_KEY"
200 OKJSON
{
"success": true,
"platform": "huggingface",
"endpoint": "/v1/huggingface/search/readmes",
"schema_version": "2",
"data": {
"<field>": "<value>"
},
"pagination": {
"next_cursor": "<string | null>",
"has_more": "<boolean>"
},
"unavailable": [],
"credits_used": "<integer>"
}

Parameters

Query parameters for GET /v1/huggingface/search/readmes. Send your key in the x-api-key header.

NameRequiredDescription
queryYesSearch text.
typeNoOnly this kind of repository.
limitNoItems per page, 1-100. A page can hold fewer. Default: 20.
cursorNoPass pagination.next_cursor from the previous response to get the next page. Keep the other parameters the same.

Response

This endpoint is beta: data holds the platform's own fields under our naming rules (snake_case keys, string ids, ISO times where the platform gives a timestamp) rather than a unified post or profile, and those fields may change.

Every field, error and example is in the Hugging Face Search Readmes API reference.

How much does the Hugging Face Search Readmes API cost?

20 credits per successful call.

  • Failed calls are free

    A call that errors or finds nothing costs 0 credits.

  • Know the price first

    Add dry_run=1 and the response quotes the call without making it. Nothing is charged.

  • One balance

    API calls and Chrome extension exports share the same credits, on the free plan too.

Hugging Face Search Readmes API: frequently asked questions

Send GET /v1/huggingface/search/readmes with the query parameter and your key in the x-api-key header. Search the text of Hugging Face READMEs and code files.