What is the endpoint for Statement of account V2?

The Statement of account V2 endpoint is POST https://connect.patsnap.com/open-user/statement/v2.

What data can Statement of account V2 return?

Statement of account V2 Support input time range to get API calls and billing information. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for Statement of account V2?

The OpenAPI schema is available at /openapi.json#/paths/~1open-user~1statement~1v2/post. You can also browse the full specification at /openapi.json.

Statement of account V2

post

https://connect.patsnap.com/open-user/statement/v2

Try in Sandbox

Support input time range to get API calls and billing information

Only the API call information of the current account can be obtained. If the time span is long, it may take longer to return the results. Detailed records are collected from 8 o'clock every day.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`apikey` Required	`string`	`abc123456`	API Key
`client_secret` Required	`string`	`abc123456`	API secret
`time_start` Required	`string`	`20250101`	Start date
`time_end` Required	`string`	`20250301`	End date

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`usage`	`array`	`[ { "fee_times": 1, "used_money": 0, "usage_times": 1, "request_path": "/basic-patent-data/fulltext-image", "serial_number": "P042", "request_path_name": "<cn>[P042]全文附图</cn><us>[P042]Fulltext Image</us>" } ]`	Details of usage for each billing interface
`fee_times`	`number`	`80`	Chargeable times
`used_money`	`number`	`123.45`	Amount used
`usage_times`	`number`	`100`	Usage times
`request_path`	`string`	`/basic-patent-data/fulltext-image`	API request path
`serial_number`	`string`	`P042`	Serial number
`request_path_name`	`string`	`[P042]Fulltext Image`	API name
`combo_usage`	`array`	`[ { "url": "/ai/quick-search-report/query", "url_name": "<cn>[AI34-3]预研报告查询（Beta）</cn><us>[AI34-3]Quick-search report Query(Beta)</us>", "used_num": 21 }, { "url": "/ai/formulation-agent-query", "url_name": "<cn>[M001-2]配方助手-报告查询</cn><us>[M001-2]Formulation agent query</us>", "used_num": 7 } ]`	Details of usage for each counting interface
`url`	`string`	`/ai/quick-search-report/query`	Interface URL
`url_name`	`string`	`[AI34-3]Quick-search report Query(Beta)`	Interface name
`used_num`	`integer<int32>`	`21`	Usage count
`usage_num`	`integer<int32>`	`21`	Usage count
`usage_money`	`number`	`100`	The amount spent on the billing interface
`combo_use_num`	`integer<int32>`	`100`	Count the usage times of the interface
`combo_usage_num`	`integer<int32>`	`100`	The number of times the interface counts
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": {
    "usage": [
      {
        "fee_times": 80,
        "used_money": 123.45,
        "usage_times": 100,
        "request_path": "/basic-patent-data/fulltext-image",
        "serial_number": "P042",
        "request_path_name": "[P042]全文附图"
      }
    ],
    "combo_usage": [
      {
        "url": "/ai/quick-search-report/query",
        "url_name": "[AI34-3]预研报告查询（Beta）",
        "used_num": 21,
        "usage_num": 21
      }
    ],
    "usage_money": 100,
    "combo_use_num": 100,
    "combo_usage_num": 100
  },
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200000`	API call exceeds the total limit set by the platform!
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	The current call rate is too fast, exceeding the current configuration limit QPS!
`67200003`	The key and secret parameters for applying for the token are incorrect or the client has been disabled!
`67200004`	The requested api does not have permission. Please contact our support personnel!
`67200005`	Insufficient account balance/number of calls!
`67200006`	The client has exceeded the activation validity period!
`67200007`	The current call exceeds the configured usage limit of the day!
`67200008`	Please check if the required apikey in the query parameter has been transmitted!
`67200009`	The apikey does not match the passed bearerToken. Please check if a valid token is being used!
`67200012`	The request is illegal!
`67200100`	The current server status is busy, request response timeout!
`67200101`	The API requested currently does not exist. Please check the request path!

HTTP Status Codes

Status Code	Description
`0`	Success
`201`	Created
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms