{"openapi":"3.1.0","info":{"title":"PrismaData — Ofício Requisitório","version":"1.0.0","termsOfService":"https://prismadata.io/terms","contact":{"name":"PrismaData Support Team","url":"https://prismadata.io/contact","email":"suporte.api@prismadata.io"},"license":{"name":"Proprietary","url":"https://api.prismadata.io/license"},"description":"A API de Oficios Requisitorios permite consultar informacoes sobre precatorios e RPVs (Requisicoes de Pequeno Valor) vinculados a credores identificados por CPF ou CNPJ.\n\nA consulta pode ser feita por **identificador do credor** (CPF/CNPJ) ou por **nome do credor** (busca por similaridade utilizando trigramas).\n\nDois endpoints estao disponiveis:\n- **Consulta de credito**: retorna um resumo consolidado dos creditos do credor (quantidade e valor estimado de precatorios e RPVs).\n- **Detalha credito**: retorna a lista completa de oficios requisitorios com informacoes detalhadas de cada credito.\n"},"servers":[{"url":"https://api.prismadata.io/v1","description":"Ambiente de Produção"}],"security":[{"X-Apikey":[]},{"api_key":[]},{"BearerAuth":[]}],"tags":[{"name":"Ofício Requisitório","description":"A API de Oficios Requisitorios permite consultar informacoes sobre precatorios e RPVs (Requisicoes de Pequeno Valor) vinculados a credores identificados por CPF ou CNPJ.\n\nA consulta pode ser feita por **identificador do credor** (CPF/CNPJ) ou por **nome do credor** (busca por similaridade utilizando trigramas).\n\nDois endpoints estao disponiveis:\n- **Consulta de credito**: retorna um resumo consolidado dos creditos do credor (quantidade e valor estimado de precatorios e RPVs).\n- **Detalha credito**: retorna a lista completa de oficios requisitorios com informacoes detalhadas de cada credito.\n"}],"paths":{"/credit/precatorio_rpv/consulta_credito":{"get":{"tags":["Ofício Requisitório"],"summary":"Resumo de precatórios e RPVs de um credor","description":"Retorna um resumo consolidado dos creditos (precatorios e RPVs) de determinado credor, incluindo quantidades e valores estimados atualizados.","operationId":"consulta_rpv_precatorio_credor_consulta_rpv_precatorio_credor_get","parameters":[{"name":"id_credor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"description":"CPF ou CNPJ do credor que se deseja consultar","title":"Id Credor"},"description":"CPF ou CNPJ do credor que se deseja consultar"},{"name":"nome_credor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Nome do credor que se deseja consultar os créditos","title":"Nome Credor"},"description":"Nome do credor que se deseja consultar os créditos"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsultaCreditoResponse"},"example":{"prismadata__precatorio_rpv__id_credor":24880102865,"prismadata__precatorio_rpv__nome_credor":"Geraldo Soares de Oliveira Junior","prismadata__precatorio_rpv__tipo_id_credor":"CPF","prismadata__precatorio_rpv__quantidade_creditos_precatorio":4,"prismadata__precatorio_rpv__valor_estimado_creditos_precatorio":177865.15,"prismadata__precatorio_rpv__quantidade_creditos_rpv":0,"prismadata__precatorio_rpv__valor_estimado_creditos_rpv":0}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"401":{"description":"Unauthorized - Missing or invalid API key (X-Apikey header or api_key query parameter)","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"403":{"description":"Forbidden - Missing privileges to retrieve data","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"422":{"description":"Validation Error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"$ref":"#/components/responses/RateLimitExceeded"}},"x-codeSamples":[{"lang":"curl","source":"curl \"https://api.prismadata.io/v1/credit/precatorio_rpv/consulta_credito\" \\\n  -H \"X-Apikey: ak_xxxxxxxxxxxxxxxx\""},{"lang":"Python","source":"import httpx\n\nresp = httpx.get(\n    \"https://api.prismadata.io/v1/credit/precatorio_rpv/consulta_credito\",\n    headers={\"X-Apikey\": \"ak_xxxxxxxxxxxxxxxx\"},\n)\ndados = resp.json()"},{"lang":"Python SDK","source":"from prismadata import Client\n\nclient = Client(api_key=\"ak_xxxxxxxxxxxxxxxx\")\nresult = client.precatory(cpf_cnpj=\"12345678901\")\nprint(result)"},{"lang":"R SDK","source":"library(prismadata)\n\nclient <- prismadata_client(api_key = \"ak_xxxxxxxxxxxxxxxx\")\nresult <- client$precatory(cpf_cnpj = \"12345678900\")\nprint(result)"},{"lang":"TypeScript SDK","source":"import { PrismaDataClient } from \"prismadata\";\n\nconst client = new PrismaDataClient({ apiKey: \"ak_xxxxxxxxxxxxxxxx\" });\nconst result = await client.precatory({ cpfCnpj: \"12345678901\" });\nconsole.log(result);"}]}},"/credit/precatorio_rpv/detalha_credito":{"get":{"tags":["Ofício Requisitório"],"summary":"Detalhe dos ofícios requisitórios de um credor","description":"Retorna a lista completa de oficios requisitorios com informacoes detalhadas de cada credito, incluindo numeros de processo, tribunal, valores e datas de expedicao.","operationId":"lista_rpv_precatorio_credor_lista_rpv_precatorio_credor_get","parameters":[{"name":"id_credor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"description":"CPF ou CNPJ do credor que se deseja consultar","title":"Id Credor"},"description":"CPF ou CNPJ do credor que se deseja consultar"},{"name":"nome_credor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Nome do credor que se deseja consultar os créditos","title":"Nome Credor"},"description":"Nome do credor que se deseja consultar os créditos"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetalhaCreditoResponse"},"example":{"items":[{"prismadata__detalha_precatorio_rpv__id_credor":"248.801.028-65","prismadata__detalha_precatorio_rpv__tipo_id_credor":"CPF","prismadata__detalha_precatorio_rpv__especie_do_credito":"precatorio","prismadata__detalha_precatorio_rpv__numero_precatorio_rpv":"0232618-03.2022.8.26.0500","prismadata__detalha_precatorio_rpv__numero_processo_execucao":"0003793-05.2021.8.26.0068","prismadata__detalha_precatorio_rpv__numero_processo_conhecimento":"1502692-58.2018.8.26.0068","prismadata__detalha_precatorio_rpv__nome_credor":"Geraldo Soares de Oliveira Junior","prismadata__detalha_precatorio_rpv__tribunal":"TJSP","prismadata__detalha_precatorio_rpv__valor_de_face":41558.18,"prismadata__detalha_precatorio_rpv__valor_estimado_atualizado":56340.69,"prismadata__detalha_precatorio_rpv__percentual_credito_cedido":0.0,"prismadata__detalha_precatorio_rpv__link_oficio":"","prismadata__detalha_precatorio_rpv__data_expedicao_oficio_credito":"02/08/2022"},{"prismadata__detalha_precatorio_rpv__id_credor":"248.801.028-65","prismadata__detalha_precatorio_rpv__tipo_id_credor":"CPF","prismadata__detalha_precatorio_rpv__especie_do_credito":"precatorio","prismadata__detalha_precatorio_rpv__numero_precatorio_rpv":"0252135-91.2022.8.26.0500","prismadata__detalha_precatorio_rpv__numero_processo_execucao":"0004773-46.2019.8.26.0318","prismadata__detalha_precatorio_rpv__numero_processo_conhecimento":"1500024-77.2017.8.26.0318","prismadata__detalha_precatorio_rpv__nome_credor":"Geraldo Soares de Oliveira Junior","prismadata__detalha_precatorio_rpv__tribunal":"TJSP","prismadata__detalha_precatorio_rpv__valor_de_face":40047.73,"prismadata__detalha_precatorio_rpv__valor_estimado_atualizado":60412.64,"prismadata__detalha_precatorio_rpv__percentual_credito_cedido":0.0,"prismadata__detalha_precatorio_rpv__link_oficio":"","prismadata__detalha_precatorio_rpv__data_expedicao_oficio_credito":"19/08/2022"}]}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"401":{"description":"Unauthorized - Missing or invalid API key (X-Apikey header or api_key query parameter)","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"403":{"description":"Forbidden - Missing privileges to retrieve data","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"422":{"description":"Validation Error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"$ref":"#/components/responses/RateLimitExceeded"}},"x-codeSamples":[{"lang":"curl","source":"curl \"https://api.prismadata.io/v1/credit/precatorio_rpv/detalha_credito\" \\\n  -H \"X-Apikey: ak_xxxxxxxxxxxxxxxx\""},{"lang":"Python","source":"import httpx\n\nresp = httpx.get(\n    \"https://api.prismadata.io/v1/credit/precatorio_rpv/detalha_credito\",\n    headers={\"X-Apikey\": \"ak_xxxxxxxxxxxxxxxx\"},\n)\ndados = resp.json()"},{"lang":"Python SDK","source":"from prismadata import Client\n\nclient = Client(api_key=\"ak_xxxxxxxxxxxxxxxx\")\nresult = client.precatory_detail(cpf_cnpj=\"12345678901\")\nprint(result)"},{"lang":"R SDK","source":"library(prismadata)\n\nclient <- prismadata_client(api_key = \"ak_xxxxxxxxxxxxxxxx\")\nresult <- client$precatory_detail(cpf_cnpj = \"12345678900\")\nprint(result)"},{"lang":"TypeScript SDK","source":"import { PrismaDataClient } from \"prismadata\";\n\nconst client = new PrismaDataClient({ apiKey: \"ak_xxxxxxxxxxxxxxxx\" });\nconst result = await client.precatoryDetail({ cpfCnpj: \"12345678901\" });\nconsole.log(result);"}]}}},"components":{"securitySchemes":{"X-Apikey":{"type":"apiKey","in":"header","name":"X-Apikey","description":"Token de acesso via header."},"api_key":{"type":"apiKey","in":"query","name":"api_key","description":"Token de acesso via query parameter."},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT obtido via POST /auth/token"}},"headers":{"X-RateLimit-Limit":{"description":"Número máximo de requisições permitidas por minuto para o usuário.","schema":{"type":"integer","example":60}},"X-RateLimit-Remaining":{"description":"Número de requisições restantes na janela de rate limit atual.","schema":{"type":"integer","example":57}},"X-RateLimit-Reset":{"description":"Unix timestamp (segundos) indicando quando a janela de rate limit será reiniciada.","schema":{"type":"integer","example":1738281600}}},"responses":{"RateLimitExceeded":{"description":"Too Many Requests - Rate limit ou quota excedidos.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"text/plain":{"schema":{"type":"string"},"examples":{"rate_limit":{"summary":"Rate limit excedido","value":"rate limit exceeded"},"quota":{"summary":"Quota excedida","value":"limit exceeded: 1000 requests used, limit is 1000"}}}}}},"schemas":{"ConsultaCreditoResponse":{"type":"object","title":"ConsultaCreditoResponse","description":"Resumo consolidado dos creditos (precatorios e RPVs) de um credor.","properties":{"prismadata__precatorio_rpv__id_credor":{"anyOf":[{"type":"integer"},{"type":"string"}],"description":"CPF ou CNPJ do credor consultado","title":"Prismadata Precatorio Rpv Id Credor"},"prismadata__precatorio_rpv__nome_credor":{"type":"string","description":"Nome completo do credor","title":"Prismadata Precatorio Rpv Nome Credor"},"prismadata__precatorio_rpv__tipo_id_credor":{"type":"string","description":"Tipo do identificador (CPF ou CNPJ)","title":"Prismadata Precatorio Rpv Tipo Id Credor"},"prismadata__precatorio_rpv__quantidade_creditos_precatorio":{"type":"integer","description":"Quantidade de precatorios vinculados ao credor","title":"Prismadata Precatorio Rpv Quantidade Creditos Precatorio"},"prismadata__precatorio_rpv__valor_estimado_creditos_precatorio":{"type":"number","description":"Valor estimado atualizado dos precatorios em reais","title":"Prismadata Precatorio Rpv Valor Estimado Creditos Precatorio"},"prismadata__precatorio_rpv__quantidade_creditos_rpv":{"type":"integer","description":"Quantidade de RPVs vinculados ao credor","title":"Prismadata Precatorio Rpv Quantidade Creditos Rpv"},"prismadata__precatorio_rpv__valor_estimado_creditos_rpv":{"type":"number","description":"Valor estimado atualizado das RPVs em reais","title":"Prismadata Precatorio Rpv Valor Estimado Creditos Rpv"}},"required":["prismadata__precatorio_rpv__id_credor","prismadata__precatorio_rpv__nome_credor","prismadata__precatorio_rpv__tipo_id_credor","prismadata__precatorio_rpv__quantidade_creditos_precatorio","prismadata__precatorio_rpv__valor_estimado_creditos_precatorio","prismadata__precatorio_rpv__quantidade_creditos_rpv","prismadata__precatorio_rpv__valor_estimado_creditos_rpv"]},"DetalhaCreditoItem":{"type":"object","title":"DetalhaCreditoItem","description":"Detalhes de um oficio requisitorio individual.","properties":{"prismadata__detalha_precatorio_rpv__id_credor":{"type":"string","description":"CPF ou CNPJ formatado do credor","title":"Prismadata Detalha Precatorio Rpv Id Credor"},"prismadata__detalha_precatorio_rpv__tipo_id_credor":{"type":"string","description":"Tipo do identificador (CPF ou CNPJ)","title":"Prismadata Detalha Precatorio Rpv Tipo Id Credor"},"prismadata__detalha_precatorio_rpv__especie_do_credito":{"type":"string","description":"Especie do credito (precatorio ou rpv)","title":"Prismadata Detalha Precatorio Rpv Especie Do Credito"},"prismadata__detalha_precatorio_rpv__numero_precatorio_rpv":{"type":"string","description":"Numero do precatorio ou RPV","title":"Prismadata Detalha Precatorio Rpv Numero Precatorio Rpv"},"prismadata__detalha_precatorio_rpv__numero_processo_execucao":{"type":"string","description":"Numero do processo de execucao","title":"Prismadata Detalha Precatorio Rpv Numero Processo Execucao"},"prismadata__detalha_precatorio_rpv__numero_processo_conhecimento":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Numero do processo de conhecimento (quando disponivel)","title":"Prismadata Detalha Precatorio Rpv Numero Processo Conhecimento"},"prismadata__detalha_precatorio_rpv__nome_credor":{"type":"string","description":"Nome completo do credor","title":"Prismadata Detalha Precatorio Rpv Nome Credor"},"prismadata__detalha_precatorio_rpv__tribunal":{"type":"string","description":"Sigla do tribunal (ex TJSP, TJMG, TJRJ)","title":"Prismadata Detalha Precatorio Rpv Tribunal"},"prismadata__detalha_precatorio_rpv__valor_de_face":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Valor de face do credito em reais","title":"Prismadata Detalha Precatorio Rpv Valor De Face"},"prismadata__detalha_precatorio_rpv__valor_estimado_atualizado":{"type":"number","description":"Valor estimado atualizado em reais","title":"Prismadata Detalha Precatorio Rpv Valor Estimado Atualizado"},"prismadata__detalha_precatorio_rpv__percentual_credito_cedido":{"type":"number","description":"Percentual do credito que foi cedido (0.0 a 1.0)","title":"Prismadata Detalha Precatorio Rpv Percentual Credito Cedido"},"prismadata__detalha_precatorio_rpv__link_oficio":{"type":"string","description":"Link para o oficio no tribunal (pode estar vazio)","title":"Prismadata Detalha Precatorio Rpv Link Oficio"},"prismadata__detalha_precatorio_rpv__data_expedicao_oficio_credito":{"type":"string","description":"Data de expedicao do oficio (formato DD/MM/YYYY)","title":"Prismadata Detalha Precatorio Rpv Data Expedicao Oficio Credito"}},"required":["prismadata__detalha_precatorio_rpv__id_credor","prismadata__detalha_precatorio_rpv__tipo_id_credor","prismadata__detalha_precatorio_rpv__especie_do_credito","prismadata__detalha_precatorio_rpv__numero_precatorio_rpv","prismadata__detalha_precatorio_rpv__numero_processo_execucao","prismadata__detalha_precatorio_rpv__nome_credor","prismadata__detalha_precatorio_rpv__tribunal","prismadata__detalha_precatorio_rpv__valor_estimado_atualizado","prismadata__detalha_precatorio_rpv__percentual_credito_cedido","prismadata__detalha_precatorio_rpv__data_expedicao_oficio_credito"]},"DetalhaCreditoResponse":{"type":"object","title":"DetalhaCreditoResponse","description":"Lista detalhada dos oficios requisitorios de um credor.","properties":{"items":{"type":"array","description":"Lista de oficios requisitorios","items":{"$ref":"#/components/schemas/DetalhaCreditoItem"}}},"required":["items"]},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}