API for GST Return Filling Status and GSTIN Details

We provide free API to access all the Information about the GST Number (aka GSTIN). To use the API, signup for a free account at rapidapi.com. Generate a free API key (x-rapidapi-key) and pass it as header to the below URL.

Getting Started

  1. 1. Create your account at rapidapi.com
  2. 2. Visit gst-return-status on RapidApi API Page and add it to Your App
  3. 3. This will generate a Rapid API KEY
  4. 4. Send this Rapid API KEY to the API URL to get all the details
  5. 5. Read the rate limits at the end of this page.
If you have any queries or getting error while using the API, feel free to contact us.

GSTIN Info API

Request

URL

https://gst-return-status.p.rapidapi.com/gstininfo/YOURGSTIN

Request:

GET

Headers

content-type: 'application/json'
x-rapidapi-key: YOUR Rapid API KEY
x-rapidapi-host: 'gst-return-status.p.rapidapi.com',
      

Response

Success Response

{
  "data": {
    "returns": {
      "GSTR1-2020-2021-March": { "dof": "11/04/2021" },
      "GSTR1-2020-2021-January": { "dof": "11/02/2021" },
      "GSTR3B-2020-2021-October": { "dof": "18/11/2020" },
      "GSTR9-2020-2021-Annual": { "dof": "20/10/2020" }
    },
    "periodicity":{
      "2020-2021":"MONTHLY",
      "2021-2022":"MONTHLY"
    },
    "meta": {
      "periodicitytime":"2021-12-16T05:32:00Z",
      "dealingtime":"2021-11-01T16:32:01Z",
      "detailstime":"2021-11-24T10:29:26Z",
      "returntime":"2021-12-16T05:32:00Z",
      "isreturnpast":true
    },
    "details": {
      "principalplace":"Ground Floor, 92, Sun view, Mahatma Phule Naka, Savarkar Nagar, Maharashtra",
      "pan":"AAJCM9929L",
      "legalname":"MADRECHA SOLUTIONS PRIVATE LIMITED",
      "doc":NULL,
      "registrationtype":"Regular",
      "gstinstatus":"Active",
      "businessnature":["Supplier of Services"],
      "gstinstatusfetched":"2021-11-24",
      "entitytype":"Private Limited Company",
      "pincode":"400606",
      "tradename":"MADRECHA SOLUTIONS PRIVATE LIMITED",
      "dor":"2020-08-10"
    },
    "dealing":{
      "S-998314":"Information technology (IT) design and development services",
      "S-997331":"Licensing services for the right to use computer software and databases."
    }
  },
  "success": true,
  "gstin": "27AAJCM9929L1ZM"
}
      

Details

The response contains 3 keys

  1. data(Object): This is the main response. See below for more details
  2. success (Boolean): If the API was sucessful, it will be true
  3. gstin(String): GST Number (aka GSTIN) for which the data is shown

data contains 4 keys

  1. details(Object): Master information about the Dealer/GSTIN
  2. returns (Map): All the GST Retunrs filed by Dealer with Date of Filing
  3. periodicity(Object): GST Return filing periodicity
  4. dealing(Map): HSN Code (along with description) for which the dealer had obtained GST registration.
  5. meta(Object): Details about the API and when the data was fetched from GST portal.

data.details contains following keys. There can be more keys than the mentioned below.

  1. legalname (String): Legal Name
  2. tradename (String): Trade Name
  3. pan (String): PAN ie. Permanent Account Number used by Income Tax
  4. dor (Date in String): Date of Registration
  5. doc (Date in String | Null): Date of Cancellation (in case the GSTIN is cancelled). null if it's not cancelled.
  6. registrationtype (String): Registration Type [example: Regular, Composition, etc]
  7. gstinstatus (String): Status of GST Number [example: Active, Cancelled, Hold, etc]
  8. entitytype (String): Legal Status of the Dealer
  9. principalplace (String): Dealer's Main Address
  10. pincode (Number in String): Pin code
  11. businessnature (Array of String): Nature of Business
  12. gstinstatusfetched (Date in String): When was the details fetched from GST Portal

Rate Limits

To keep our servers running reliably for all our users, there are following rate limits in the free account:

  1. 1. Per Minute 20 Request &
  2. 2. Per Day 1000 Request
More details


We strive for a Latency of less than 700ms (Miliseconds). This is possible because we use very fast No SQL Database to serve all the requests. If the data is stale, we will get the details from GSP & GST Portal. In that case, if GSP or GST portal response times are high, the Latency can in the range of 5 to 6 seconds. In a rare scenario where GSP or the GST portal takes more then 7 seconds to respond, we serve the stale data from database.

To view the current (almost live) average latency, check out API Listing page at rapidapi.com