API for GST Return Filling Status and GSTIN Details

Apart from the API mentioned in this page, we also provide bulk export of GSTIN data based on filters specified by you. If you have such requirement contact us at adarsh[at]madrecha.com. Pricing is 2 Rs per GSTIN. Minimum invoice amount - 50,000 INR.

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.

GSTIN Info API

Request URL

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

Headers

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

Success Response

{
  "data": {
    "dty": "Regular",
    "hsn": [
      "997331",
      "998314"
    ],
    "lgnm": "MADRECHA SOLUTIONS PRIVATE LIMITED",
    "pan": "AAJCM9929L",
    "sts": "Active",
    "tradeName": "MADRECHA SOLUTIONS PRIVATE LIMITED",
    "compCategory": "Green",
    "gstin": "27AAJCM9929L1ZM",
    "mandatedeInvoice": "No",
    "ctb": "Private Limited Company",
    "rgdt": "10/08/2020",
    "adr": "Ground Floor, 92, Sun view, Mahatma Phule Naka, Savarkar Nagar, Thane, Maharashtra, 400606",
    "meta": {
      "syncMasterDate": "2022-10-11",
      "syncReturnDate": "2022-10-16"
    },
    "fillingFreq": {
      "2022_Q1": "M",
      "2022_Q2": "M",
      "2022_Q3": "M",
      "2022_Q4": "M",
      "2021_Q1": "M",
      "2021_Q2": "M",
      "2021_Q3": "M",
      "2021_Q4": "M"
    },
    "returns": [
      {
        "fy": "2022-2023",
        "dof": "08/10/2022",
        "rtntype": "GSTR1",
        "taxp": "September"
      },
      {
        "fy": "2022-2023",
        "dof": "11/09/2022",
        "rtntype": "GSTR1",
        "taxp": "August"
      },
      {
        "fy": "2022-2023",
        "dof": "10/08/2022",
        "rtntype": "GSTR1",
        "taxp": "July"
      },
      {
        "fy": "2022-2023",
        "dof": "11/07/2022",
        "rtntype": "GSTR1",
        "taxp": "June"
      }
    ]
  },
  "success": true
}

Response Details

The response contains 2 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

data contains these keys:

  1. compCategory(String): (Beta) Compliance Category based on GSTR1 Filling date. Example: Green, Yellow, Red
  2. lgnm (String): Legal Name
  3. tradeName (String): Trade Name
  4. dty (String): Registration Type Example: Regular, Composition
  5. sts (String): Status of GST Number Example: Active, Cancelled
  6. pan(String): PAN ie. Permanent Account Number used by Income Tax
  7. rgdt(Date in String): Date of Registration
  8. cxdt (Date in String | Null): Date of Cancellation (in case the GSTIN is cancelled). null/empty string if it's not cancelled.
  9. ctb (String): Legal Status of the Dealer
  10. adr (String): Dealer's Main Address. It is also reffered as principal place of business.
  11. pincode (String): Pin code
  12. ctj (String): Central Jurisdiction
  13. stj (String): State Jurisdiction
  14. aggreTurnOver (String): Slab in which the Aggregate Turnover of the GSTIN falls.
  15. aggreTurnOverFY (String): Financial Year for which the Aggregate Turnover of the GSTIN is shown
  16. returns(Array of Object): Latest 20 GST Returns filled.
  17. fillingFreq(Object): GST Return filing periodicity
  18. hsn(Array of String): HSN/SAC Code for which the dealer had obtained GST registration.
  19. meta(Object): Details about when the data was fetched from GST portal. See below for more details.
  20. nba (Array of String): Nature of Business

data.meta contains 4 keys

  1. latestgtsr1 (String): Period for which the latest GSTR1 is filled
  2. latestgtsr3b (String): Period for which the latest GSTR3B is filled
  3. latestgtsr3b (Date as String in YYYY-MM-DD format): The GSTIN Profile was fetched on this date
  4. latestgtsr3b (Date as String in YYYY-MM-DD format): The GSTIN Return list was fetched on this date

Rate Limits & Latency

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 about rate limits

We strive for a Latency of less than 300ms (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

Looking for support and invoicing for GST API? check out https://portal.jamku.app/pricing#gstparty