Skip to content
Longport WhaleLongport Whale
File import

Get S3 Download URL

Get a file download URL from the object-storage key and file upload record.

Request parameters

  • Required: key (object-storage key), file_upload_id (file upload record ID)

Returns

On success, returns the file download URL. See the response definition below for field meanings.

GEThttps://b-api.lbkrs.com/corporate_action/download_url

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_corporate.corporate_query

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Parameters

keystringRequired

S3 Object Key

file_upload_idstringRequired

File Upload ID

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
urlstring
HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs