Skip to main content
GET
Read an account profile

No connected channel required

Every other endpoint in this API acts through a channel you connected. Reads do not: the server queries its own data provider, so /reads/* works for any public account — a competitor, a prospect, someone you have never touched. That is also why a target is mandatory. There is no “me” here (nothing in the request identifies an account of yours), so pass username or user_id:
user_id is cheaper than username — a handle costs an extra lookup upstream, and reads are metered per upstream call. Every profile response returns id; reuse it for follow-up reads.

Authorizations

Authorization
string
header
required

Your Groniz API key

Path Parameters

platform
enum<string>
required

Platform to read from. Only x is supported today.

Available options:
x

Query Parameters

username
string

Account handle, without the @. Either username or user_id is required.

user_id
string

Platform user id. Cheaper than username (skips the handle lookup). Either username or user_id is required.

Response

The normalized profile

id
string

Platform user id

Example:

"44196397"

username
string
Example:

"elonmusk"

name
string
Example:

"Elon Musk"

description
string

Account bio

created_at
string

When the account was created

verified
boolean
protected
boolean
location
string
url
string

Expanded profile URL (not the t.co shortlink)

metrics
object