Skip to main content
Use this endpoint to fetch the details of a specific repository by its numeric ID. The response includes your effective permission level for that repository, which determines what operations you can perform on it.

Request

GET https://api.alphacast.io/repositories/{repository_id}

Authentication

This endpoint requires HTTP Basic Auth. Pass your API key as the username and leave the password empty.

Path parameters

repository_id
integer
required
The numeric ID of the repository to retrieve.

Response

Returns a single repository object on success.
id
integer
Unique numeric identifier for the repository.
name
string
Display name of the repository.
description
string
Optional description of the repository’s contents or purpose.
privacy
string
Visibility setting. Either "Public" or "Private".
team
string
The team this repository belongs to, if applicable.
permission
string
Your access level for this repository. One of "Owner", "Admin", "Write", "Clone", or "Read". This field is determined by the server based on your API key and cannot be set directly.

Errors

StatusMeaning
404No repository with the given ID exists, or you do not have access to it.

Example

curl -u YOUR_API_KEY: \
  https://api.alphacast.io/repositories/101
{
  "id": 101,
  "name": "Emerging Markets Macro",
  "description": "GDP, inflation, and rates for EM economies",
  "privacy": "Private",
  "team": "research",
  "permission": "Owner"
}