Track GST Return

get
Track GST Return

https://api.sandbox.co.in/gsp/public/gstr?gstin={{gstin}}&financial_year={{financial_year}}
This API will be used to view e-filed returns details.
Request
Response
Request
Headers
Authorization
required
string
JWT Authorization token
x-api-key
required
string
Public key required to authorize API access.
x-api-version
required
string
Query Parameters
gstin
required
string
15-character alphanumeric unique identifier assigned to business entities registering under the GST regime
financial_year
required
string
e.g. FY 2019-20
Response
200: OK
[
{
"valid": "Y",
"mof": "ONLINE",
"dof": "21-03-2020",
"rtntype": "GSTR3B",
"ret_prd": "022020",
"arn": "AA240218411233A",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "17-02-2020",
"rtntype": "GSTR3B",
"ret_prd": "012020",
"arn": "AA240118012325E",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "31-01-2020",
"rtntype": "GSTR1",
"ret_prd": "122019",
"arn": "AA2412179312371",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "22-01-2020",
"rtntype": "GSTR3B",
"ret_prd": "122019",
"arn": "AA241217593123P",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "20-12-2019",
"rtntype": "GSTR3B",
"ret_prd": "112019",
"arn": "AA240917937123W",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "20-11-2019",
"rtntype": "GSTR3B",
"ret_prd": "102019",
"arn": "AA2411174471234",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "16-11-2019",
"rtntype": "GSTR1",
"ret_prd": "092019",
"arn": "AA2410174912345",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "17-10-2019",
"rtntype": "GSTR3B",
"ret_prd": "092019",
"arn": "AA2409174651234",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "20-09-2019",
"rtntype": "GSTR3B",
"ret_prd": "082019",
"arn": "AA2408173961234",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "21-08-2019",
"rtntype": "GSTR3B",
"ret_prd": "072019",
"arn": "AB2407170912345",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "27-07-2019",
"rtntype": "GSTR1",
"ret_prd": "062019",
"arn": "AA2407175095123",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "20-07-2019",
"rtntype": "GSTR3B",
"ret_prd": "062019",
"arn": "AA2406199486123",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "21-06-2019",
"rtntype": "GSTR3B",
"ret_prd": "052019",
"arn": "AA2405199354561",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "16-05-2019",
"rtntype": "GSTR3B",
"ret_prd": "042019",
"arn": "AA2404194123456",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "30-04-2019",
"rtntype": "GSTR1",
"ret_prd": "032019",
"arn": "AB2403194123456",
"status": "Filed"
},
{
"valid": "Y",
"mof": "ONLINE",
"dof": "17-04-2019",
"rtntype": "GSTR3B",
"ret_prd": "032019",
"arn": "AA2403196123456",
"status": "Filed"
}
]
401: Unauthorized
{
"code": 401,
"message": "Unauthorized"
}
403: Forbidden
Invalid token
Access denied
Invalid token
{
"code": 403,
"message": "Not a valid token"
}
Access denied
{
"code": 403,
"message": "Access denied"
}
500: Internal Server Error
Invalid GSTIN Pattern
Insufficient Balance
Invalid GSTIN Pattern
{
"status": 500,
"message": "Invalid GSTIN pattern"
}
Insufficient Balance
{
"code": 500,
"message": "Insufficient balance. Please purchase credits."
}

JWT Authorization token can be obtained by calling the Authenticate API

Example Request

cURL
Java
Node.js
Python
cURL
curl --location --request GET 'https://api.sandbox.co.in/gsp/public/gstr?gstin=24AAACJ3770E2ZZ&financial_year=FY%202017-18' \
--header 'Authorization: eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw' \
--header 'x-api-key: key_live_Ade**************************Uxs' \
--header 'x-api-version: 3.3'
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://api.sandbox.co.in/gsp/public/gstr?gstin=24AAACJ3770E2ZZ&financial_year=FY%202017-18")
.header("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw")
.header("x-api-key", "key_live_Ade**************************Uxs")
.header("x-api-version", "3.3")
.asString();
Node.js
var https = require('follow-redirects').https;
var fs = require('fs');
var options = {
'method': 'GET',
'hostname': 'https://api.sandbox.co.in',
'path': '/gsp/public/gstr?gstin=24AAACJ3770E2ZZ&financial_year=FY%202017-18',
'headers': {
'Authorization': 'eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw',
'x-api-key': 'key_live_Ade**************************Uxs',
'x-api-version': '3.3'
},
'maxRedirects': 20
};
var req = https.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
req.end();
Python
import requests
url = "https://api.sandbox.co.in/gsp/public/gstr?gstin=24AAACJ3770E2ZZ&financial_year=FY 2017-18"
payload = {}
headers = {
'Authorization': 'eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw',
'x-api-key': 'key_live_Ade**************************Uxs',
'x-api-version': '3.3'
}
response = requests.request("GET", url, headers=headers, data = payload)
print(response.text.encode('utf8'))