curl -X GET https://api.finscreener.in/api/access \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
import requests
response = requests.get(
"https://api.finscreener.in/api/access",
headers={"Authorization": f"Bearer {token}"}
)
access = response.json()
gst = access["datasets"]["recently_registered"]["gst"]
if gst["enabled"]:
print("Queryable from", gst["date_window"]["from"], "to", gst["date_window"]["to"])
if gst["territory"]["restricted"]:
print("Limited to states:", gst["territory"]["states"])
{
"account": {
"user_id": "usr_8f21c0",
"email": "dev@example.com",
"username": "example-dev",
"is_enterprise": false
},
"authenticated_via": "api_key",
"datasets": {
"recently_registered": {
"gst": {
"enabled": true,
"granted_by": "subscription",
"reason": null,
"territory": {
"restricted": true,
"states": ["Karnataka", "Maharashtra"],
"districts": null,
"pincodes": null
},
"date_window": {
"from": "2026-07-07",
"to": "2026-07-18",
"anchored_to_subscription": true
},
"plans": [
{
"plan_name": "New GST - Karnataka",
"interval": "monthly",
"granted_by": "subscription",
"expires_at": "2026-08-07T00:00:00Z"
}
]
},
"company": {
"enabled": false,
"granted_by": null,
"reason": "no_active_plan_grants_this_dataset",
"territory": {
"restricted": false,
"states": null,
"districts": null,
"pincodes": null
},
"date_window": null,
"plans": []
},
"director": {
"enabled": false,
"granted_by": null,
"reason": "no_active_plan_grants_this_dataset",
"territory": {
"restricted": false,
"states": null,
"districts": null,
"pincodes": null
},
"date_window": null,
"plans": []
}
}
},
"credits": [
{
"type": "gst_contact",
"balance": 250,
"total_credits": 500,
"used_credits": 250,
"last_updated": "2026-07-18T09:14:00Z"
}
],
"rate_limits": {
"detail_endpoints": {
"used_today": 42,
"daily_limit": 100,
"remaining": 58
},
"date": "2026-07-18"
},
"generated_at": "2026-07-18T11:02:31Z"
}
Overview
Access & Entitlements
What this API key is allowed to do
GET
/
api
/
access
curl -X GET https://api.finscreener.in/api/access \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
import requests
response = requests.get(
"https://api.finscreener.in/api/access",
headers={"Authorization": f"Bearer {token}"}
)
access = response.json()
gst = access["datasets"]["recently_registered"]["gst"]
if gst["enabled"]:
print("Queryable from", gst["date_window"]["from"], "to", gst["date_window"]["to"])
if gst["territory"]["restricted"]:
print("Limited to states:", gst["territory"]["states"])
{
"account": {
"user_id": "usr_8f21c0",
"email": "dev@example.com",
"username": "example-dev",
"is_enterprise": false
},
"authenticated_via": "api_key",
"datasets": {
"recently_registered": {
"gst": {
"enabled": true,
"granted_by": "subscription",
"reason": null,
"territory": {
"restricted": true,
"states": ["Karnataka", "Maharashtra"],
"districts": null,
"pincodes": null
},
"date_window": {
"from": "2026-07-07",
"to": "2026-07-18",
"anchored_to_subscription": true
},
"plans": [
{
"plan_name": "New GST - Karnataka",
"interval": "monthly",
"granted_by": "subscription",
"expires_at": "2026-08-07T00:00:00Z"
}
]
},
"company": {
"enabled": false,
"granted_by": null,
"reason": "no_active_plan_grants_this_dataset",
"territory": {
"restricted": false,
"states": null,
"districts": null,
"pincodes": null
},
"date_window": null,
"plans": []
},
"director": {
"enabled": false,
"granted_by": null,
"reason": "no_active_plan_grants_this_dataset",
"territory": {
"restricted": false,
"states": null,
"districts": null,
"pincodes": null
},
"date_window": null,
"plans": []
}
}
},
"credits": [
{
"type": "gst_contact",
"balance": 250,
"total_credits": 500,
"used_credits": 250,
"last_updated": "2026-07-18T09:14:00Z"
}
],
"rate_limits": {
"detail_endpoints": {
"used_today": 42,
"daily_limit": 100,
"remaining": 58
},
"date": "2026-07-18"
},
"generated_at": "2026-07-18T11:02:31Z"
}
The authoritative description of what your API key may do. Call it once at integration
time (and periodically afterwards) to self-configure: it states, per dataset, whether
access is granted and by what, the exact territory and the exact date window that will
be applied to every query, plus your rate limits and credit balances.
The data endpoints enforce exactly what this endpoint reports. If a result set is
narrower than you expected, compare it against
GET /api/access before assuming a bug.Headers
string
required
Bearer token:
Bearer <access_token>Response
object
string
Always
api_key — developer API tokens are only issued via API key exchange.object
Entitlements per dataset. Contains
recently_registered, which holds one entry each
for gst, company and director.Show dataset entitlement properties
Show dataset entitlement properties
boolean
Whether this dataset may be queried at all. When
false, the matching feed
endpoint returns 403 NO_DATASET_ACCESS.string | null
What grants the access:
subscription, offer, or enterprise. null when not enabled.string | null
Why access is withheld, e.g.
no_active_plan_grants_this_dataset or
unknown_dataset. null when access is granted.object
object | null
array
Credit balances on the account, each with
type, balance, total_credits,
used_credits and last_updated.object
Current rate limit consumption, including
detail_endpoints with used_today,
daily_limit and remaining.string
When this snapshot was produced (UTC).
curl -X GET https://api.finscreener.in/api/access \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
import requests
response = requests.get(
"https://api.finscreener.in/api/access",
headers={"Authorization": f"Bearer {token}"}
)
access = response.json()
gst = access["datasets"]["recently_registered"]["gst"]
if gst["enabled"]:
print("Queryable from", gst["date_window"]["from"], "to", gst["date_window"]["to"])
if gst["territory"]["restricted"]:
print("Limited to states:", gst["territory"]["states"])
{
"account": {
"user_id": "usr_8f21c0",
"email": "dev@example.com",
"username": "example-dev",
"is_enterprise": false
},
"authenticated_via": "api_key",
"datasets": {
"recently_registered": {
"gst": {
"enabled": true,
"granted_by": "subscription",
"reason": null,
"territory": {
"restricted": true,
"states": ["Karnataka", "Maharashtra"],
"districts": null,
"pincodes": null
},
"date_window": {
"from": "2026-07-07",
"to": "2026-07-18",
"anchored_to_subscription": true
},
"plans": [
{
"plan_name": "New GST - Karnataka",
"interval": "monthly",
"granted_by": "subscription",
"expires_at": "2026-08-07T00:00:00Z"
}
]
},
"company": {
"enabled": false,
"granted_by": null,
"reason": "no_active_plan_grants_this_dataset",
"territory": {
"restricted": false,
"states": null,
"districts": null,
"pincodes": null
},
"date_window": null,
"plans": []
},
"director": {
"enabled": false,
"granted_by": null,
"reason": "no_active_plan_grants_this_dataset",
"territory": {
"restricted": false,
"states": null,
"districts": null,
"pincodes": null
},
"date_window": null,
"plans": []
}
}
},
"credits": [
{
"type": "gst_contact",
"balance": 250,
"total_credits": 500,
"used_credits": 250,
"last_updated": "2026-07-18T09:14:00Z"
}
],
"rate_limits": {
"detail_endpoints": {
"used_today": 42,
"daily_limit": 100,
"remaining": 58
},
"date": "2026-07-18"
},
"generated_at": "2026-07-18T11:02:31Z"
}