--- agentTools: projectIndex: https://pricing-culture-consumer.readme.io/llms.txt --- # Search An endpoint to search all Preferred Stock assets available. Various filters can be used, please refer to search guide for details. The result is a list of asset ids matching search criteria specified, where the id can be used on the Profile endpoint to retrieve detailed information about the asset. # OpenAPI definition ````json { "openapi": "3.0.0", "info": { "title": "Consumer APIs", "version": "2.0.1", "description": "## IntroductionTESTING\n\nWelcome! Pricing Culture provides APIs that enable you to build exciting user experiences and applications for investors in fractional assets.\n\nUsing Pricing Culture’s Asset API, you can easily:\n\n1. Search for assets listed on the leading fractional investing exchanges\n1. Access rich profile data on each individual asset\n1. Get latest and historic prices of all assets across all major exchanges\n\nUsing Pricing Culture’s Index API, you get complimentary access to all public CulDex indices. Including:\n\n1. Over 10 sub-indices that track a variety of asset types\n1. The Total Market index that keeps track of the entire universe of fractional assets\n1. Continuously updated pricing and holdings data for all indices\n\n\n## Getting Started\n\nThe Pricing Culture API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses and uses standard HTTP response codes, authentication and verbs.\n\n## Creating an account\n\nPricing Culture's API supports two types of accounts:\n\n**Free Account**: This account type allows users limited access to resources available by the Pricing Culture API.\n\n**Paid Account**: This account type allows users to access all resources available by the Pricing Culture API.\n\n**NOTE:** ``null`` or ``\"\"`` will be returned in a response parameter if it is not supported by your account type.\n\nTo create an account signup here\n\n## Search\n\nSome attribute names can be used as parameters on /search endpoints, with the following general format =:|||...\n\ni.e. /search?asset_status=in:OFFERING_OPEN|SECONDARY_TRADING_OPEN will return all assets with \"OFFERING_OPEN\" or \"SECONDARY_TRADING_OPEN\"\n\nMultiple attributes can be used, further narrowing the results for better match\n\ni.e. /search?asset_status=in:OFFERING_OPEN&security_type=in:ASSET\n\nFor numeric or date type attributes, inequality operators can be used\n\ni.e. /search?price=gte:100\n\nText Attributes Operators\n'in' - exact match, accepts multiple values\n'not_in' - exact match, accepts multiple values\n'like' - fuzzy match, accept only one value\nDate / Numeric Attributes Operators\n'gt' - strictly greater than\n'gte' - greater than or equal to\n'lt' - strictly less than\n'lte' - less than or equal to\n\n## Authentication and Security\n\nThere are two credentials required to authenticate with our API.\n\n 1. Subscription Key\n 1. Subscription Secret\n\nThe **subscription key** in conjunction with the **subscription secret** is used to authenticate all requests.\n\n### **Subscription Key**\nThe subscription key is part of the header of all requests sent to our API. You can create an unlimited number of subscription keys in your account.\n\nThe subscription key is assigned to the ```key``` parameter of the header.\n\n### **Subscription Secret**\nThe subscription secret is part of the header of all requests sent to our API. Each subscription key you create will generate its own unique subscription secret in your dashboard.\n\nThe subscription secret is assigned to the ```secret``` parameter of the header.\n\n## Status Codes\n\nPricing Culture uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success and Codes in the 4xx range indicate an error that failed given the information provided.\n\n| code |name | summary|\n|------|-----|---------|\n| 200 | OK | Everything worked as expected.|\n| 400 | Bad Request | The request was unacceptable, often due to missing a required parameter.|\n| 401 | Unauthorized | Invalid API or Secret key provided |\n| 403 | Forbidden | The API key doesn't have permissions to perform the request. |" }, "servers": [ { "description": "Production", "url": "https://consumer.api.pricingculture.com" } ], "paths": { "/api/assets/security/equity/preferred_stock/search": { "parameters": [], "get": { "summary": "Search", "operationId": "get-api-assets-security-equity-preferred-stock-search", "responses": { "200": { "$ref": "#/components/responses/SearchResponse" } }, "description": "An endpoint to search all Preferred Stock assets available. Various filters can be used, please refer to search guide for details.\n\nThe result is a list of asset ids matching search criteria specified, where the id can be used on the Profile endpoint to retrieve detailed information about the asset.", "parameters": [ { "$ref": "#/components/parameters/api-key" }, { "$ref": "#/components/parameters/secret" }, { "schema": { "type": "integer" }, "in": "query", "name": "id", "description": "ID of the asset" }, { "schema": { "type": "string" }, "in": "query", "name": "name", "description": "Name of the asset" }, { "schema": { "type": "string" }, "in": "query", "name": "description", "description": "Description of the asset" }, { "schema": { "type": "string", "enum": [ "OFFERING_ANNOUNCED", "OFFERING_OPEN", "OFFERING_CLOSED", "OFFERING_CANCELED", "SECONDARY_TRADING_OPEN", "SECONDARY_TRADING_CLOSED", "TAKEN_PRIVATE" ] }, "in": "query", "name": "asset_status", "description": "Status of the asset" }, { "schema": { "type": "integer" }, "in": "query", "name": "platform_id", "description": "ID of platform of the asset" } ], "tags": [ "Preferred Stock" ] } } }, "components": { "schemas": { "SearchResponseModel": { "type": "object", "properties": { "status": { "type": "string" }, "objects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } } }, "pagination": { "type": "object", "properties": { "total_count": { "type": "integer" }, "next": { "type": "object", "properties": { "page_num": { "type": "integer" }, "page_size": { "type": "integer" } } }, "prev": { "type": "object", "properties": { "page_num": { "type": "integer" }, "page_size": { "type": "integer" } } } } } }, "x-examples": { "Example 1": { "status": "OK", "objects": [ { "id": 33685 }, { "id": 33606 }, { "id": 33689 }, { "id": 33245 }, { "id": 33238 }, { "id": 33383 }, { "id": 33419 }, { "id": 33497 }, { "id": 33377 }, { "id": 33415 }, { "id": 33385 }, { "id": 33370 }, { "id": 33356 }, { "id": 33354 }, { "id": 33720 }, { "id": 33555 }, { "id": 33597 }, { "id": 33262 }, { "id": 33265 }, { "id": 33594 }, { "id": 33400 }, { "id": 33693 }, { "id": 33254 }, { "id": 33252 }, { "id": 33588 }, { "id": 33510 }, { "id": 33529 }, { "id": 33554 }, { "id": 33387 }, { "id": 33412 }, { "id": 33532 }, { "id": 33512 }, { "id": 33500 }, { "id": 33509 }, { "id": 33535 }, { "id": 33537 }, { "id": 33545 }, { "id": 33534 }, { "id": 33557 }, { "id": 33561 }, { "id": 33584 }, { "id": 33586 }, { "id": 33578 }, { "id": 33580 }, { "id": 33600 }, { "id": 33605 }, { "id": 33604 }, { "id": 33607 }, { "id": 33705 }, { "id": 33724 }, { "id": 33687 }, { "id": 33694 }, { "id": 33722 }, { "id": 33723 }, { "id": 33702 }, { "id": 33711 }, { "id": 33712 }, { "id": 33355 }, { "id": 33734 }, { "id": 33366 }, { "id": 33417 }, { "id": 33418 }, { "id": 33402 }, { "id": 33360 }, { "id": 33375 }, { "id": 33416 }, { "id": 33258 }, { "id": 33267 }, { "id": 33248 }, { "id": 33268 }, { "id": 33250 }, { "id": 33261 }, { "id": 33341 }, { "id": 33344 }, { "id": 33352 }, { "id": 33348 }, { "id": 33349 }, { "id": 33353 } ], "pagination": { "total_count": 28777, "next": { "page_num": 3, "page_size": 1000 }, "prev": { "page_num": 1, "page_size": 1000 } } } }, "description": "SMI Asset Search Response" } }, "responses": { "SearchResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponseModel" }, "examples": { "example-1": { "value": { "status": "OK", "objects": [ { "id": 33685 }, { "id": 33606 }, { "id": 33689 }, { "id": 33245 }, { "id": 33238 }, { "id": 33383 }, { "id": 33419 }, { "id": 33497 }, { "id": 33377 }, { "id": 33415 }, { "id": 33385 }, { "id": 33370 }, { "id": 33356 }, { "id": 33354 }, { "id": 33720 }, { "id": 33555 }, { "id": 33597 }, { "id": 33262 }, { "id": 33265 }, { "id": 33594 }, { "id": 33400 }, { "id": 33693 }, { "id": 33254 }, { "id": 33252 }, { "id": 33588 }, { "id": 33510 }, { "id": 33529 }, { "id": 33554 }, { "id": 33387 }, { "id": 33412 }, { "id": 33532 }, { "id": 33512 }, { "id": 33500 }, { "id": 33509 }, { "id": 33535 }, { "id": 33537 }, { "id": 33545 }, { "id": 33534 }, { "id": 33557 }, { "id": 33561 }, { "id": 33584 }, { "id": 33586 }, { "id": 33578 }, { "id": 33580 }, { "id": 33600 }, { "id": 33605 }, { "id": 33604 }, { "id": 33607 }, { "id": 33705 }, { "id": 33724 }, { "id": 33687 }, { "id": 33694 }, { "id": 33722 }, { "id": 33723 }, { "id": 33702 }, { "id": 33711 }, { "id": 33712 }, { "id": 33355 }, { "id": 33734 }, { "id": 33366 }, { "id": 33417 }, { "id": 33418 }, { "id": 33402 }, { "id": 33360 }, { "id": 33375 }, { "id": 33416 }, { "id": 33258 }, { "id": 33267 }, { "id": 33248 }, { "id": 33268 }, { "id": 33250 }, { "id": 33261 }, { "id": 33341 }, { "id": 33344 }, { "id": 33352 }, { "id": 33348 }, { "id": 33349 }, { "id": 33353 } ], "pagination": { "total_count": 28777, "next": { "page_num": 3, "page_size": 1000 }, "prev": { "page_num": 1, "page_size": 1000 } } } } } } } } }, "parameters": { "secret": { "name": "secret", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Pricing Culture assigned secret" }, "api-key": { "name": "api-key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Pricing Culture assigned api-key" } } }, "x-tagGroups": [ { "name": "Section One", "tags": [ "ASSET API", "ASSET GLOSSARY" ] }, { "name": "Section Two", "tags": [ "INDEX API", "INDEX GLOSSARY" ] } ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true }, "_id": { "buffer": { "0": 98, "1": 158, "2": 123, "3": 128, "4": 27, "5": 26, "6": 165, "7": 0, "8": 20, "9": 13, "10": 59, "11": 169 } } } ````