Skip to main content

GET /api/suspension

Interface Description

This interface provides suspension and resumption information queries for major global exchanges (SSE, NYSE, NASDAQ). All interfaces return JSON data, sorted by announcement time in descending order.

Request Frequency

PlanIndividual Request for a Single InterfaceRequesting Multiple HTTP Interfaces at the Same Time
FreeOne request per minute1. Only one interface can be requested every 10 seconds.
2. When requesting multiple interfaces, note that the /batch-kline interface requires a 10-second interval.
3. All interfaces combined: maximum 10 requests per minute (one every 6 seconds).
4. Maximum 1,000 requests per day; usage resumes after midnight the next day if exceeded.
BasicOne request per minute1. Only one interface can be requested in the same second.
2. When requesting multiple interfaces, note that the /batch-kline interface requires a 3-second interval.
3. All interfaces combined: maximum 60 requests per minute (one per second).
4. Maximum 86,400 requests per day; usage resumes after midnight the next day if exceeded.
PremiumOne request per minute1. All interfaces combined: up to 10 requests per second.
2. When requesting multiple interfaces, note that the /batch-kline interface requires a 2-second interval.
3. All interfaces combined: maximum 600 requests per minute (10 per second).
4. Maximum 864,000 requests per day; usage resumes after midnight the next day if exceeded.
ProfessionalOne request per minute1. All interfaces combined: up to 20 requests per second.
2. When requesting multiple interfaces, note that the /batch-kline interface requires a 1-second interval.
3. All interfaces combined: maximum 1,200 requests per minute (20 per second).
4. Maximum 1,728,000 requests per day; usage resumes after midnight the next day if exceeded.
All Hong Kong StocksOne request per minute1. All interfaces combined: up to 20 requests per second.
2. When requesting multiple interfaces, note that the /batch-kline interface requires a 1-second interval.
3. All interfaces combined: maximum 1,200 requests per minute (20 per second).
4. Maximum 1,728,000 requests per day; usage resumes after midnight the next day if exceeded.
All A SharesOne request per minute1. All interfaces combined: up to 20 requests per second.
2. When requesting multiple interfaces, note that the /batch-kline interface requires a 1-second interval.
3. All interfaces combined: maximum 1,200 requests per minute (20 per second).
4. Maximum 1,728,000 requests per day; usage resumes after midnight the next day if exceeded.
All US StocksOne request per minute1. All interfaces combined: up to 20 requests per second.
2. When requesting multiple interfaces, note that the /batch-kline interface requires a 1-second interval.
3. All interfaces combined: maximum 1,200 requests per minute (20 per second).
4. Maximum 1,728,000 requests per day; usage resumes after midnight the next day if exceeded.

Interface Limitations

  1. Be sure to read: HTTP Interface Restrictions
  2. Be sure to read: Error Code Description

API Endpoints

1. Query Shanghai Stock Exchange suspension and resumption information: 2. Query New York Stock Exchange suspension and resumption information: 3. Query NASDAQ suspension and resumption information:

Request Examples

1. Get SSE Data Interface

Interface Information

  • URL: /api/suspension/sse
  • Method: GET
  • Description: Get all suspension and resumption information from the Shanghai Stock Exchange (SSE)

Request Parameters

FieldTypeRequiredDescription
tokenstringYesUser subscription token
pageintegerNoQuery page number
sizeintegerNoPage size

Response Example

{
  "success": true,
  "timestamp": "2024-01-15T10:30:00",
  "totalCount": 125,
  "data": [
    {
      "symbol": "600000",
      "symbolName": "Shanghai Pudong Development Bank",
      "haltReason": "Trading halt due to major matters",
      "haltDate": "2024-01-15",
      "haltTime": "09:30:00",
      "haltPeriod": "Full-day trading halt",
      "resumeDate": "2024-01-16",
      "resumeTime": "09:30:00",
      "publishDate": "2024-01-14 18:00:00"
    }
  ]
}

Response Field Description

FieldTypeRequiredDescription
» successbooleanYesWhether the request was successful
» timestampstringYesResponse timestamp (format: yyyy-MM-dd’T’HH:mm:ss)
» totalCountintegerYesTotal number of records
» dataarrayYesSuspension and resumption information list
» totalPagesintegerNoTotal number of pages (returned for paginated queries)
» currentPageintegerNoCurrent page (returned for paginated queries)
» currentSizeintegerNoNumber of records on the current page (returned for paginated queries)

data Field (Object in the Suspension and Resumption Information List)

FieldTypeNullableDescription
» symbolstringNoStock code
» symbolNamestringYesStock name
» haltReasonstringYesSuspension reason
» haltDatestringYesSuspension date
» haltTimestringYesSuspension time
» haltPeriodstringYesSuspension period
» resumeDatestringYesResumption date
» resumeTimestringYesResumption time
» publishDatestringNoAnnouncement time

Call Example

curl -X GET "https://quote.alltick.co/api/suspension/sse?token=your_token&page=1&size=10" -H "Accept: application/json"

2. Get NYSE Data Interface

Interface Information

  • URL: /api/suspension/nyse
  • Method: GET
  • Description: Get all suspension and resumption information from the New York Stock Exchange (NYSE)

Request Parameters

FieldTypeRequiredDescription
tokenstringYesUser subscription token
pageintegerNoQuery page number
sizeintegerNoPage size

Response Example

{
  "success": true,
  "timestamp": "2024-01-15T10:30:00",
  "totalCount": 89,
  "data": [
    {
      "symbol": "AAPL",
      "haltReason": "News pending",
      "haltDate": "2024-01-15",
      "haltTime": "10:15:00",
      "haltDateTime": "2024-01-15 10:15:00",
      "resumeDate": "2024-01-15",
      "resumeTime": "11:00:00",
      "resumeDateTime": "2024-01-15 11:00:00",
      "sourceExchange": "NYSE",
      "publishDate": "2024-01-15 10:10:00"
    }
  ]
}

Response Field Description

FieldTypeRequiredDescription
» successbooleanYesWhether the request was successful
» timestampstringYesResponse timestamp (format: yyyy-MM-dd’T’HH:mm:ss)
» totalCountintegerYesTotal number of records
» dataarrayYesSuspension and resumption information list
» totalPagesintegerNoTotal number of pages (returned for paginated queries)
» currentPageintegerNoCurrent page (returned for paginated queries)
» currentSizeintegerNoNumber of records on the current page (returned for paginated queries)

data Field (Object in the Suspension and Resumption Information List)

FieldTypeNullableDescription
» symbolstringNoStock code
» symbolNamestringYesStock name
» haltReasonstringYesSuspension reason
» haltTimestringYesSuspension time
» haltDateTimestringYesSuspension date and time
» resumeDatestringYesResumption date
» resumeTimestringYesResumption time
» resumeDateTimestringYesResumption date and time
» sourceExchangestringYesExchange code
» publishDatestringNoAnnouncement time

Call Example

curl -X GET "https://quote.alltick.co/api/suspension/nyse?token=your_token&page=1&size=10" -H "Accept: application/json"

3. Get NASDAQ Data Interface

Interface Information

  • URL: /api/suspension/nasdaq
  • Method: GET
  • Description: Get all suspension and resumption information from NASDAQ

Request Parameters

FieldTypeRequiredDescription
tokenstringYesUser subscription token
pageintegerNoQuery page number
sizeintegerNoPage size

Response Example

{
  "success": true,
  "timestamp": "2024-01-15T10:30:00",
  "totalCount": 156,
  "data": [
    {
      "symbol": "GOOGL",
      "haltDate": "2024-01-15",
      "haltTime": "13:45:00",
      "haltDateTime": "2024-01-15 13:45:00",
      "sourceExchange": "NASDAQ",
      "haltReason": "Volatility halt",
      "pauseThresholdPrice": "145.50",
      "resumeDate": "2024-01-15",
      "resumeTime": "14:00:00",
      "resumeDateTime": "2024-01-15 14:00:00",
      "publishDate": "2024-01-15 13:44:30"
    }
  ]
}

Response Field Description

FieldTypeRequiredDescription
» successbooleanYesWhether the request was successful
» timestampstringYesResponse timestamp (format: yyyy-MM-dd’T’HH:mm:ss)
» totalCountintegerYesTotal number of records
» dataarrayYesSuspension and resumption information list
» totalPagesintegerNoTotal number of pages (returned for paginated queries)
» currentPageintegerNoCurrent page (returned for paginated queries)
» currentSizeintegerNoNumber of records on the current page (returned for paginated queries)

data Field (Object in the Suspension and Resumption Information List)

FieldTypeNullableDescription
» symbolstringNoStock code
» symbolNamestringYesStock name
» haltDatestringYesSuspension date
» haltTimestringYesSuspension time
» haltDateTimestringYesSuspension date and time
» sourceExchangestringYesExchange code
» haltReasonstringYesSuspension reason
» pauseThresholdPricestringYesPause threshold price
» resumeDatestringYesResumption date
» resumeTimestringYesQuote resumption time
» resumeDateTimestringYesTrading resumption time
» publishDatestringNoAnnouncement time

Call Example

curl -X GET "https://quote.alltick.co/api/suspension/nasdaq?token=your_token&page=1&size=10" -H "Accept: application/json"

Error Response

All interfaces return the following format when an error occurs:
{
  "success": false,
  "error": "Error description information"
}
HTTP Status Code: 500

Error Response Field Description

FieldTypeRequiredDescription
successbooleanYesWhether the request was successful. Fixed as false.
errorstringYesError description information

Notes

  1. All interfaces do not support pagination and return the full data for the most recent year.
  2. Data is sorted by announcement time in descending order (latest first).
  3. Time formats in the response:
    • timestamp field: ISO format (yyyy-MM-dd’T’HH:mm:ss)
    • Other time fields: yyyy-MM-dd HH:mm:ss
  4. It is recommended to set an appropriate timeout. Large data volumes may require more time.
  5. Empty field descriptions:
    • “No”: the field always has a value and will not be null.
    • “Yes”: the field may be null or an empty string. The caller must handle empty values.

AllTick Website

Official website: https://alltick.co/

Interface Debug

Debug SSE Suspension Interface

Debug NYSE Suspension Interface

Debug NASDAQ Suspension Interface