What is the endpoint for [P030]Pledge?

The [P030]Pledge endpoint is GET https://connect.patsnap.com/advanced-patent-data/pledge-data.

Where can I find the OpenAPI schema for [P030]Pledge?

The OpenAPI schema is available at /openapi.json#/paths/~1advanced-patent-data~1pledge-data/get. You can also browse the full specification at /openapi.json.

[P030]Pledge

Q: What data can [P030]Pledge return?

[P030]Pledge Receive pledge data by patent_id or patent_number. This includes pledge contract number, effective date, pledgee, pledger, and pledge type. See the Response Schema and Success Response Example on this page for the full structure.

get

https://connect.patsnap.com/advanced-patent-data/pledge-data

Try in Sandbox

Receive pledge data by patent_id or patent_number. This includes pledge contract number, effective date, pledgee, pledger, and pledge type.

The API supports batch requests with a maximum of 100 patents, and more patent id or patent number are separated with English comma. Batch requests are deducted from traffic/costs, and will be deducted multiple times based on the number of successful results returned.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`patent_id`	`string`	`a6a372dc-2b2c-476b-b1e4-78fab3dce33a`	patent_id
`patent_number`	`string`	`US11379121B2`	patent_number

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`array`	-	response data
`pn`	`string`	`US11205304B2`	patent number
`patent_id`	`string`	`718ead9c-4f3c-4674-8f5a-24e126827269`	patent id
`patent_pledge_data`	`array`	`Please check the form: PatentPledgeData`	pledge data
`country`	`string`	`US`	Authority code
`pledgees`	`array`	`Please check the form: PersonBaseDoc`	pledgees
`lang`	`string`	`EN`	Language
`name`	`string`	`EMC IP HOLDING COMPANY LLC`	name
`sequence`	`integer<int32>`	`1`	sequence
`pledgors`	`array`	`Please check the form: PersonBaseDoc`	pledgors
`lang`	`string`	`EN`	Language
`name`	`string`	`EMC IP HOLDING COMPANY LLC`	name
`sequence`	`integer<int32>`	`1`	sequence
`effective_date_us`	`integer<int64>`	`20181029`	Pledge effective date of US
`reel_frame`	`string`	`060332/0740`	Pledge contract number
`pledge_type`	`string`	`RELEASE OF SECURITY INTEREST IN PATENTS PREVIOUSLY RECORDED AT REEL/FRAME (054475/0434)`	Pledge type
`effective_date`	`integer<int64>`	`20220610`	Pledge effective date
`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": [
    {
      "pn": "US11205304B2",
      "patent_id": "718ead9c-4f3c-4674-8f5a-24e126827269",
      "patent_pledge_data": [
        {
          "country": "US",
          "pledgees": [
            {
              "lang": "EN",
              "name": "EMC IP HOLDING COMPANY LLC",
              "sequence": 1
            }
          ],
          "pledgors": [
            {
              "lang": "EN",
              "name": "EMC IP HOLDING COMPANY LLC",
              "sequence": 1,
              "effective_date_us": 20181029
            }
          ],
          "reel_frame": "060332/0740",
          "pledge_type": "RELEASE OF SECURITY INTEREST IN PATENTS PREVIOUSLY RECORDED AT REEL/FRAME (054475/0434)",
          "effective_date": 20220610
        }
      ]
    }
  ],
  "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
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	Quota exceeds the limit!
`67200003`	Access token expired or authentication error!
`67200004`	No permission or API package quota has exceeded the limit!
`67200005`	Insufficient balance, call failed!
`67200006`	This client has expired and call failed!

HTTP Status Codes

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