🔗 Export your Visual Studio Code Activity to a REST API.
A Visual Studio Code extension that makes it easy for you to export and display your current (and recent) workspace and file details. No authentication required, just simply download the extension and you're all set. See exported workspace and file details here.
For example: I use it to display my current activity on my personal website
Getting Started
You can download the VSCode Status extension by snehasishcodes from the Visual Studio Marketplace.
Table of Contents
Extension Guide
Activating the extension
The extension activates automatically once you download it (usual behaviour) and everytime you open VSCode.
Once the extension starts it should give you the following notification.
And you should be able to see the following button on your VSCode Status Bar.
If it didn't behave as usual, please reach us at support.
Getting your API endpoint
You can click on either of the "Open API Endpoint" button on the extension's activation notification or the "Active" button on the Status bar.
This will open your API Endpoint URL in the browser.
OR
Open the VSCode Status Extension Settings (UI) and COPY THE UID (Unique ID)
You can then replace your UID in the following URL.
https://vscode.snehasish.xyz/api/users/:YOUR_UID
API Guide
API Base URL
https://vscode.snehasish.xyz/api/
API Endpoints
GET User
GET /users/:uid
Returns current and most recent activity of user with the specified UID.
Example Response
GET /users/417612111734978277950
{
"success": true,
"data": {
"uid": "417612111734978277950",
"current": {
"started": "1735137118372",
"file": {
"name": "README",
"extension": "md",
"path": "e:\\projects\\vscode-status\\README.md",
"language": "markdown",
"size": "3.00 KB",
"lines": 91,
"position": {
"line": 91,
"column": 1
},
"errors": 0
},
"workspace": {
"name": "vscode-status",
"path": "e:\\projects\\vscode-status"
},
"debugging": false
},
"recent": {
"ended": "1735139973573",
"started": "1735137118372",
"file": {
"name": "README",
"extension": "md",
"path": "e:\\projects\\vscode-status\\README.md",
"language": "markdown",
"size": "2.98 KB",
"lines": 89,
"position": {
"line": 89,
"column": 18
},
"errors": 0
},
"workspace": {
"name": "vscode-status",
"path": "e:\\projects\\vscode-status"
},
"debugging": false
}
},
"code": 200
}
Get User SVG
Returns the specified user's information in SVG with customizable lines and fields. For example: to directly embed it as image or iframe into your website.
Query Parameters
line1
: First line of text
line2
: Second line of text
line3
: Third line of text
line4
: Fourth line of text
All of the above params are optional.
Custom Fields & Values
Fields |
Values |
{file} |
File name along with extension. Example: index.js |
{fileName} |
File name without extension. Example: index |
{fileExtension} |
File extension. Example: js |
{filePath} |
Path to the file. Example: e:\\projects\\vscode-status\\index.js |
{language} |
File language. Example: javascript |
{size} |
File size in KB. Example: 5.75 KB |
{lines} |
Total lines in file. Example: 95 |
{currentLine} |
Line position in file. Example: 12 |
{currentCol} |
Column position in current line. Example: 34 |
{errors} |
Total errors in the workspace. Example: 4 |
{workspaceName} |
Name of the current workspace. Example: vscode-status |
{workspacePath} |
Path to the current workspace. Example: e:\\projects\\vscode-status |
{debugging} |
Current debugging status (Yes / No ). Example: No |
{startedTimestamp} |
Timestamp for when the activity was started. Example: 1735137118372 |
{endedTimestamp} |
Timestamp for when (if) the activity ended. Example: 1735140603496 |
{elapsedTime} |
(Formatted) Total activity time in the current workspace. Example: 1h 4m |
Example Response
GET /users/417612111734978277950/svg?line1={file}+|+{size}&line3=on+{workspaceName}&line4=for+{elapsedTime}
Create a Project
Create any project that uses the VSCode Status API and we'll list it on this README!
For submissions join our Discord Server
Support
Something isn't working? Uh oh! We've got your back.
You can reach out for help on:
Self Hosting
Self hosting guide will be coming soon! Join our Discord for future updates
Well, I'm just a high school student creating stuff part-time but anyways. You can sponsor me (or this proj) here:
UPI: snehasishcodes@oksbi